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 "Cursor.h"
  20 #include "DispatchResult.h"
  21 #include "Encoding.h"
  22 #include "FuncRequest.h"
  23 #include "FuncStatus.h"
  24 #include "IndicesList.h"
  25 #include "LaTeXFeatures.h"
  26 #include "Lexer.h"
  27 #include "output_latex.h"
  28 #include "output_xhtml.h"
  29 #include "sgml.h"
  30 #include "TextClass.h"
  31 #include "TocBackend.h"
  32
  33 #include "support/debug.h"
  34 #include "support/docstream.h"
  35 #include "support/gettext.h"
  36 #include "support/lstrings.h"
  37
  38 #include "frontends/alert.h"
  39
  40 #include <ostream>
  41 #include <algorithm>
  42
  43 using namespace std;
  44 using namespace lyx::support;
  45
  46 namespace lyx {
  47
  48 /////////////////////////////////////////////////////////////////////
  49 //
  50 // InsetIndex
  51 //
  52 ///////////////////////////////////////////////////////////////////////
  53
  54
  55 InsetIndex::InsetIndex(Buffer * buf, InsetIndexParams const & params)
  56         : InsetCollapsable(buf), params_(params)
  57 {}
  58
  59
  60 void InsetIndex::latex(otexstream & os, OutputParams const & runparams_in) const
  61 {
  62         OutputParams runparams(runparams_in);
  63         runparams.inIndexEntry = true;
  64
  65         if (buffer().masterBuffer()->params().use_indices && !params_.index.empty()
  66             && params_.index != "idx") {
  67                 os << "\\sindex[";
  68                 os << params_.index;
  69                 os << "]{";
  70         } else {
  71                 os << "\\index";
  72                 os << '{';
  73         }
  74
  75         // get contents of InsetText as LaTeX and plaintext
  76         TexRow texrow;
  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();
  84
  85         // this will get what follows | if anything does
  86         docstring cmd;
  87
  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);
 101                 else
 102                         LYXERR0("The `|' separator was not found in the plaintext version!");
 103         }
 104
 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);
 111
 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();
 115         bool first = true;
 116         for (; it != end; ++it) {
 117                 // write the separator except the first time
 118                 if (!first)
 119                         os << '!';
 120                 else
 121                         first = false;
 122
 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())
 132                                 ? *it2 : *it;
 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                         docstring spart2;
 138                         for (size_t n = 0; n < spart.size(); ++n) {
 139                                 try {
 140                                         spart2 += runparams.encoding->latexChar(spart[n]);
 141                                 } catch (EncodingException & /* e */) {
 142                                         LYXERR0("Uncodable character in index entry. Sorting might be wrong!");
 143                                 }
 144                         }
 145                         if (spart != spart2 && !runparams.dryrun) {
 146                                 // FIXME: warning should be passed to the error dialog
 147                                 frontend::Alert::warning(_("Index sorting failed"),
 148                                 bformat(_("LyX's automatic index sorting algorithm faced\n"
 149                                   "problems with the entry '%1$s'.\n"
 150                                   "Please specify the sorting of this entry manually, as\n"
 151                                   "explained in the User Guide."), spart));
 152                         }
 153                         // remove remaining \'s for the sorting part
 154                         docstring const ppart =
 155                                 subst(spart2, from_ascii("\\"), docstring());
 156                         os << ppart;
 157                         os << '@';
 158                 }
 159                 docstring const tpart = *it;
 160                 os << tpart;
 161                 if (it2 < levels_plain.end())
 162                         ++it2;
 163         }
 164         // write the bit that followed "|"
 165         if (!cmd.empty()) {
 166                 os << "|" << cmd;
 167         }
 168         os << '}';
 169 }
 170
 171
 172 int InsetIndex::docbook(odocstream & os, OutputParams const & runparams) const
 173 {
 174         os << "<indexterm><primary>";
 175         int const i = InsetText::docbook(os, runparams);
 176         os << "</primary></indexterm>";
 177         return i;
 178 }
 179
 180
 181 docstring InsetIndex::xhtml(XHTMLStream & xs, OutputParams const &) const
 182 {
 183         // we just print an anchor, taking the paragraph ID from
 184         // our own interior paragraph, which doesn't get printed
 185         std::string const magic = paragraphs().front().magicLabel();
 186         std::string const attr = "id='" + magic + "'";
 187         xs << html::CompTag("a", attr);
 188         return docstring();
 189 }
 190
 191
 192 bool InsetIndex::showInsetDialog(BufferView * bv) const
 193 {
 194         bv->showDialog("index", params2string(params_),
 195                         const_cast<InsetIndex *>(this));
 196         return true;
 197 }
 198
 199
 200 void InsetIndex::doDispatch(Cursor & cur, FuncRequest & cmd)
 201 {
 202         switch (cmd.action()) {
 203
 204         case LFUN_INSET_MODIFY: {
 205                 if (cmd.getArg(0) == "changetype") {
 206                         cur.recordUndoInset(ATOMIC_UNDO, this);
 207                         params_.index = from_utf8(cmd.getArg(1));
 208                         break;
 209                 }
 210                 InsetIndexParams params;
 211                 InsetIndex::string2params(to_utf8(cmd.argument()), params);
 212                 cur.recordUndoInset(ATOMIC_UNDO, this);
 213                 params_.index = params.index;
 214                 // what we really want here is a TOC update, but that means
 215                 // a full buffer update
 216                 cur.forceBufferUpdate();
 217                 break;
 218         }
 219
 220         case LFUN_INSET_DIALOG_UPDATE:
 221                 cur.bv().updateDialog("index", params2string(params_));
 222                 break;
 223
 224         default:
 225                 InsetCollapsable::doDispatch(cur, cmd);
 226                 break;
 227         }
 228 }
 229
 230
 231 bool InsetIndex::getStatus(Cursor & cur, FuncRequest const & cmd,
 232                 FuncStatus & flag) const
 233 {
 234         switch (cmd.action()) {
 235
 236         case LFUN_INSET_MODIFY:
 237                 if (cmd.getArg(0) == "changetype") {
 238                         docstring const newtype = from_utf8(cmd.getArg(1));
 239                         Buffer const & realbuffer = *buffer().masterBuffer();
 240                         IndicesList const & indiceslist = realbuffer.params().indiceslist();
 241                         Index const * index = indiceslist.findShortcut(newtype);
 242                         flag.setEnabled(index != 0);
 243                         flag.setOnOff(
 244                                 from_utf8(cmd.getArg(1)) == params_.index);
 245                         return true;
 246                 }
 247                 return InsetCollapsable::getStatus(cur, cmd, flag);
 248
 249         case LFUN_INSET_DIALOG_UPDATE: {
 250                 Buffer const & realbuffer = *buffer().masterBuffer();
 251                 flag.setEnabled(realbuffer.params().use_indices);
 252                 return true;
 253         }
 254
 255         default:
 256                 return InsetCollapsable::getStatus(cur, cmd, flag);
 257         }
 258 }
 259
 260
 261 ColorCode InsetIndex::labelColor() const
 262 {
 263         if (params_.index.empty() || params_.index == from_ascii("idx"))
 264                 return InsetCollapsable::labelColor();
 265         // FIXME UNICODE
 266         ColorCode c = lcolor.getFromLyXName(to_utf8(params_.index));
 267         if (c == Color_none)
 268                 c = InsetCollapsable::labelColor();
 269         return c;
 270 }
 271
 272
 273 docstring InsetIndex::toolTip(BufferView const &, int, int) const
 274 {
 275         docstring tip = _("Index Entry");
 276         if (buffer().params().use_indices && !params_.index.empty()) {
 277                 Buffer const & realbuffer = *buffer().masterBuffer();
 278                 IndicesList const & indiceslist = realbuffer.params().indiceslist();
 279                 tip += " (";
 280                 Index const * index = indiceslist.findShortcut(params_.index);
 281                 if (!index)
 282                         tip += _("unknown type!");
 283                 else
 284                         tip += index->index();
 285                 tip += ")";
 286         }
 287         tip += ": ";
 288         return toolTipText(tip);
 289 }
 290
 291
 292 docstring const InsetIndex::buttonLabel(BufferView const & bv) const
 293 {
 294         InsetLayout const & il = getLayout();
 295         docstring label = translateIfPossible(il.labelstring());
 296
 297         if (buffer().params().use_indices && !params_.index.empty()) {
 298                 Buffer const & realbuffer = *buffer().masterBuffer();
 299                 IndicesList const & indiceslist = realbuffer.params().indiceslist();
 300                 label += " (";
 301                 Index const * index = indiceslist.findShortcut(params_.index);
 302                 if (!index)
 303                         label += _("unknown type!");
 304                 else
 305                         label += index->index();
 306                 label += ")";
 307         }
 308
 309         if (!il.contentaslabel() || geometry(bv) != ButtonOnly)
 310                 return label;
 311         return getNewLabel(label);
 312 }
 313
 314
 315 void InsetIndex::write(ostream & os) const
 316 {
 317         os << to_utf8(layoutName());
 318         params_.write(os);
 319         InsetCollapsable::write(os);
 320 }
 321
 322
 323 void InsetIndex::read(Lexer & lex)
 324 {
 325         params_.read(lex);
 326         InsetCollapsable::read(lex);
 327 }
 328
 329
 330 string InsetIndex::params2string(InsetIndexParams const & params)
 331 {
 332         ostringstream data;
 333         data << "index";
 334         params.write(data);
 335         return data.str();
 336 }
 337
 338
 339 void InsetIndex::string2params(string const & in, InsetIndexParams & params)
 340 {
 341         params = InsetIndexParams();
 342         if (in.empty())
 343                 return;
 344
 345         istringstream data(in);
 346         Lexer lex;
 347         lex.setStream(data);
 348         lex.setContext("InsetIndex::string2params");
 349         lex >> "index";
 350         params.read(lex);
 351 }
 352
 353
 354 void InsetIndex::addToToc(DocIterator const & cpit) const
 355 {
 356         DocIterator pit = cpit;
 357         pit.push_back(CursorSlice(const_cast<InsetIndex &>(*this)));
 358         docstring str;
 359         text().forToc(str, TOC_ENTRY_LENGTH);
 360         buffer().tocBackend().toc("index").push_back(TocItem(pit, 0, str));
 361         // Proceed with the rest of the inset.
 362         InsetCollapsable::addToToc(cpit);
 363 }
 364
 365
 366 void InsetIndex::validate(LaTeXFeatures & features) const
 367 {
 368         if (buffer().masterBuffer()->params().use_indices
 369             && !params_.index.empty()
 370             && params_.index != "idx")
 371                 features.require("splitidx");
 372         InsetCollapsable::validate(features);
 373 }
 374
 375
 376 string InsetIndex::contextMenuName() const
 377 {
 378         return "context-index";
 379 }
 380
 381
 382 bool InsetIndex::hasSettings() const
 383 {
 384         return buffer().masterBuffer()->params().use_indices;
 385 }
 386
 387
 388
 389
 390 /////////////////////////////////////////////////////////////////////
 391 //
 392 // InsetIndexParams
 393 //
 394 ///////////////////////////////////////////////////////////////////////
 395
 396
 397 void InsetIndexParams::write(ostream & os) const
 398 {
 399         os << ' ';
 400         if (!index.empty())
 401                 os << to_utf8(index);
 402         else
 403                 os << "idx";
 404         os << '\n';
 405 }
 406
 407
 408 void InsetIndexParams::read(Lexer & lex)
 409 {
 410         if (lex.eatLine())
 411                 index = lex.getDocString();
 412         else
 413                 index = from_ascii("idx");
 414 }
 415
 416
 417 /////////////////////////////////////////////////////////////////////
 418 //
 419 // InsetPrintIndex
 420 //
 421 ///////////////////////////////////////////////////////////////////////
 422
 423 InsetPrintIndex::InsetPrintIndex(Buffer * buf, InsetCommandParams const & p)
 424         : InsetCommand(buf, p)
 425 {}
 426
 427
 428 ParamInfo const & InsetPrintIndex::findInfo(string const & /* cmdName */)
 429 {
 430         static ParamInfo param_info_;
 431         if (param_info_.empty()) {
 432                 param_info_.add("type", ParamInfo::LATEX_OPTIONAL);
 433                 param_info_.add("name", ParamInfo::LATEX_REQUIRED);
 434         }
 435         return param_info_;
 436 }
 437
 438
 439 docstring InsetPrintIndex::screenLabel() const
 440 {
 441         bool const printall = suffixIs(getCmdName(), '*');
 442         bool const multind = buffer().masterBuffer()->params().use_indices;
 443         if ((!multind
 444              && getParam("type") == from_ascii("idx"))
 445             || (getParam("type").empty() && !printall))
 446                 return _("Index");
 447         Buffer const & realbuffer = *buffer().masterBuffer();
 448         IndicesList const & indiceslist = realbuffer.params().indiceslist();
 449         Index const * index = indiceslist.findShortcut(getParam("type"));
 450         if (!index && !printall)
 451                 return _("Unknown index type!");
 452         docstring res = printall ? _("All indexes") : index->index();
 453         if (!multind)
 454                 res += " (" + _("non-active") + ")";
 455         else if (contains(getCmdName(), "printsubindex"))
 456                 res += " (" + _("subindex") + ")";
 457         return res;
 458 }
 459
 460
 461 bool InsetPrintIndex::isCompatibleCommand(string const & s)
 462 {
 463         return s == "printindex" || s == "printsubindex"
 464                 || s == "printindex*" || s == "printsubindex*";
 465 }
 466
 467
 468 void InsetPrintIndex::doDispatch(Cursor & cur, FuncRequest & cmd)
 469 {
 470         switch (cmd.action()) {
 471
 472         case LFUN_INSET_MODIFY: {
 473                 if (cmd.argument() == from_ascii("toggle-subindex")) {
 474                         string cmd = getCmdName();
 475                         if (contains(cmd, "printindex"))
 476                                 cmd = subst(cmd, "printindex", "printsubindex");
 477                         else
 478                                 cmd = subst(cmd, "printsubindex", "printindex");
 479                         cur.recordUndo();
 480                         setCmdName(cmd);
 481                         break;
 482                 } else if (cmd.argument() == from_ascii("check-printindex*")) {
 483                         string cmd = getCmdName();
 484                         if (suffixIs(cmd, '*'))
 485                                 break;
 486                         cmd += '*';
 487                         cur.recordUndo();
 488                         setParam("type", docstring());
 489                         setCmdName(cmd);
 490                         break;
 491                 }
 492                 InsetCommandParams p(INDEX_PRINT_CODE);
 493                 // FIXME UNICODE
 494                 InsetCommand::string2params(to_utf8(cmd.argument()), p);
 495                 if (p.getCmdName().empty()) {
 496                         cur.noScreenUpdate();
 497                         break;
 498                 }
 499                 setParams(p);
 500                 break;
 501         }
 502
 503         default:
 504                 InsetCommand::doDispatch(cur, cmd);
 505                 break;
 506         }
 507 }
 508
 509
 510 bool InsetPrintIndex::getStatus(Cursor & cur, FuncRequest const & cmd,
 511         FuncStatus & status) const
 512 {
 513         switch (cmd.action()) {
 514
 515         case LFUN_INSET_MODIFY: {
 516                 if (cmd.argument() == from_ascii("toggle-subindex")) {
 517                         status.setEnabled(buffer().masterBuffer()->params().use_indices);
 518                         status.setOnOff(contains(getCmdName(), "printsubindex"));
 519                         return true;
 520                 } else if (cmd.argument() == from_ascii("check-printindex*")) {
 521                         status.setEnabled(buffer().masterBuffer()->params().use_indices);
 522                         status.setOnOff(suffixIs(getCmdName(), '*'));
 523                         return true;
 524                 } if (cmd.getArg(0) == "index_print"
 525                     && cmd.getArg(1) == "CommandInset") {
 526                         InsetCommandParams p(INDEX_PRINT_CODE);
 527                         InsetCommand::string2params(to_utf8(cmd.argument()), p);
 528                         if (suffixIs(p.getCmdName(), '*')) {
 529                                 status.setEnabled(true);
 530                                 status.setOnOff(false);
 531                                 return true;
 532                         }
 533                         Buffer const & realbuffer = *buffer().masterBuffer();
 534                         IndicesList const & indiceslist =
 535                                 realbuffer.params().indiceslist();
 536                         Index const * index = indiceslist.findShortcut(p["type"]);
 537                         status.setEnabled(index != 0);
 538                         status.setOnOff(p["type"] == getParam("type"));
 539                         return true;
 540                 } else
 541                         return InsetCommand::getStatus(cur, cmd, status);
 542         }
 543
 544         case LFUN_INSET_DIALOG_UPDATE: {
 545                 status.setEnabled(buffer().masterBuffer()->params().use_indices);
 546                 return true;
 547         }
 548
 549         default:
 550                 return InsetCommand::getStatus(cur, cmd, status);
 551         }
 552 }
 553
 554
 555 void InsetPrintIndex::latex(otexstream & os, OutputParams const & runparams_in) const
 556 {
 557         if (!buffer().masterBuffer()->params().use_indices) {
 558                 if (getParam("type") == from_ascii("idx"))
 559                         os << "\\printindex{}";
 560                 return;
 561         }
 562         OutputParams runparams = runparams_in;
 563         os << getCommand(runparams);
 564 }
 565
 566
 567 void InsetPrintIndex::validate(LaTeXFeatures & features) const
 568 {
 569         features.require("makeidx");
 570         if (buffer().masterBuffer()->params().use_indices)
 571                 features.require("splitidx");
 572 }
 573
 574
 575 string InsetPrintIndex::contextMenuName() const
 576 {
 577         return buffer().masterBuffer()->params().use_indices ?
 578                 "context-indexprint" : string();
 579 }
 580
 581
 582 bool InsetPrintIndex::hasSettings() const
 583 {
 584         return buffer().masterBuffer()->params().use_indices;
 585 }
 586
 587
 588 namespace {
 589
 590 void parseItem(docstring & s, bool for_output)
 591 {
 592         // this does not yet check for escaped things
 593         size_type loc = s.find(from_ascii("@"));
 594         if (loc != string::npos) {
 595                 if (for_output)
 596                         s.erase(0, loc + 1);
 597                 else
 598                         s.erase(loc);
 599         }
 600         loc = s.find(from_ascii("|"));
 601         if (loc != string::npos)
 602                 s.erase(loc);
 603 }
 604
 605
 606 void extractSubentries(docstring const & entry, docstring & main,
 607                 docstring & sub1, docstring & sub2)
 608 {
 609         if (entry.empty())
 610                 return;
 611         size_type const loc = entry.find(from_ascii(" ! "));
 612         if (loc == string::npos)
 613                 main = entry;
 614         else {
 615                 main = trim(entry.substr(0, loc));
 616                 size_t const locend = loc + 3;
 617                 size_type const loc2 = entry.find(from_ascii(" ! "), locend);
 618                 if (loc2 == string::npos) {
 619                         sub1 = trim(entry.substr(locend));
 620                 } else {
 621                         sub1 = trim(entry.substr(locend, loc2 - locend));
 622                         sub2 = trim(entry.substr(loc2 + 3));
 623                 }
 624         }
 625 }
 626
 627
 628 struct IndexEntry
 629 {
 630         IndexEntry()
 631         {}
 632
 633         IndexEntry(docstring const & s, DocIterator const & d)
 634                         : dit(d)
 635         {
 636                 extractSubentries(s, main, sub, subsub);
 637                 parseItem(main, false);
 638                 parseItem(sub, false);
 639                 parseItem(subsub, false);
 640         }
 641
 642         bool equal(IndexEntry const & rhs) const
 643         {
 644                 return main == rhs.main && sub == rhs.sub && subsub == rhs.subsub;
 645         }
 646
 647         bool same_sub(IndexEntry const & rhs) const
 648         {
 649                 return main == rhs.main && sub == rhs.sub;
 650         }
 651
 652         bool same_main(IndexEntry const & rhs) const
 653         {
 654                 return main == rhs.main;
 655         }
 656
 657         docstring main;
 658         docstring sub;
 659         docstring subsub;
 660         DocIterator dit;
 661 };
 662
 663 bool operator<(IndexEntry const & lhs, IndexEntry const & rhs)
 664 {
 665         return lhs.main < rhs.main
 666                         || (lhs.main == rhs.main && lhs.sub < rhs.sub)
 667                         || (lhs.main == rhs.main && lhs.sub == rhs.sub && lhs.subsub < rhs.subsub);
 668 }
 669
 670 } // anon namespace
 671
 672
 673 docstring InsetPrintIndex::xhtml(XHTMLStream &, OutputParams const & op) const
 674 {
 675         BufferParams const & bp = buffer().masterBuffer()->params();
 676
 677         // we do not presently support multiple indices, so we refuse to print
 678         // anything but the main index, so as not to generate multiple indices.
 679         // NOTE Multiple index support would require some work. The reason
 680         // is that the TOC does not know about multiple indices. Either it would
 681         // need to be told about them (not a bad idea), or else the index entries
 682         // would need to be collected differently, say, during validation.
 683         if (bp.use_indices && getParam("type") != from_ascii("idx"))
 684                 return docstring();
 685
 686         Toc const & toc = buffer().tocBackend().toc("index");
 687         if (toc.empty())
 688                 return docstring();
 689
 690         // Collection the index entries in a form we can use them.
 691         Toc::const_iterator it = toc.begin();
 692         Toc::const_iterator const en = toc.end();
 693         vector<IndexEntry> entries;
 694         for (; it != en; ++it)
 695                 entries.push_back(IndexEntry(it->str(), it->dit()));
 696         stable_sort(entries.begin(), entries.end());
 697
 698         Layout const & lay = bp.documentClass().htmlTOCLayout();
 699         string const & tocclass = lay.defaultCSSClass();
 700         string const tocattr = "class='tochead " + tocclass + "'";
 701
 702         // we'll use our own stream, because we are going to defer everything.
 703         // that's how we deal with the fact that we're probably inside a standard
 704         // paragraph, and we don't want to be.
 705         odocstringstream ods;
 706         XHTMLStream xs(ods);
 707
 708         xs << html::StartTag("div", "class='index'");
 709         xs << html::StartTag(lay.htmltag(), lay.htmlattr())
 710                  << _("Index")
 711                  << html::EndTag(lay.htmltag());
 712         xs << html::StartTag("ul", "class='main'");
 713         Font const dummy;
 714
 715         vector<IndexEntry>::const_iterator eit = entries.begin();
 716         vector<IndexEntry>::const_iterator const een = entries.end();
 717         // tracks whether we are already inside a main entry (1),
 718         // a sub-entry (2), or a sub-sub-entry (3). see below for the
 719         // details.
 720         int level = 1;
 721         // the last one we saw
 722         IndexEntry last;
 723         int entry_number = -1;
 724         for (; eit != een; ++eit) {
 725                 Paragraph const & par = eit->dit.innerParagraph();
 726                 if (entry_number == -1 || !eit->equal(last)) {
 727                         if (entry_number != -1) {
 728                                 // not the first time through the loop, so
 729                                 // close last entry or entries, depending.
 730                                 if (level == 3) {
 731                                         // close this sub-sub-entry
 732                                         xs << html::EndTag("li") << html::CR();
 733                                         // is this another sub-sub-entry within the same sub-entry?
 734                                         if (!eit->same_sub(last)) {
 735                                                 // close this level
 736                                                 xs << html::EndTag("ul") << html::CR();
 737                                                 level = 2;
 738                                         }
 739                                 }
 740                                 // the point of the second test here is that we might get
 741                                 // here two ways: (i) by falling through from above; (ii) because,
 742                                 // though the sub-entry hasn't changed, the sub-sub-entry has,
 743                                 // which means that it is the first sub-sub-entry within this
 744                                 // sub-entry. In that case, we do not want to close anything.
 745                                 if (level == 2 && !eit->same_sub(last)) {
 746                                         // close sub-entry
 747                                         xs << html::EndTag("li") << html::CR();
 748                                         // is this another sub-entry with the same main entry?
 749                                         if (!eit->same_main(last)) {
 750                                                 // close this level
 751                                                 xs << html::EndTag("ul") << html::CR();
 752                                                 level = 1;
 753                                         }
 754                                 }
 755                                 // again, we can get here two ways: from above, or because we have
 756                                 // found the first sub-entry. in the latter case, we do not want to
 757                                 // close the entry.
 758                                 if (level == 1 && !eit->same_main(last)) {
 759                                         // close entry
 760                                         xs << html::EndTag("li") << html::CR();
 761                                 }
 762                         }
 763
 764                         // we'll be starting new entries
 765                         entry_number = 0;
 766
 767                         // We need to use our own stream, since we will have to
 768                         // modify what we get back.
 769                         odocstringstream ent;
 770                         XHTMLStream entstream(ent);
 771                         OutputParams ours = op;
 772                         ours.for_toc = true;
 773                         par.simpleLyXHTMLOnePar(buffer(), entstream, ours, dummy);
 774
 775                         // these will contain XHTML versions of the main entry, etc
 776                         // remember that everything will already have been escaped,
 777                         // so we'll need to use NextRaw() during output.
 778                         docstring main;
 779                         docstring sub;
 780                         docstring subsub;
 781                         extractSubentries(ent.str(), main, sub, subsub);
 782                         parseItem(main, true);
 783                         parseItem(sub, true);
 784                         parseItem(subsub, true);
 785
 786                         if (level == 3) {
 787                                 // another subsubentry
 788                                 xs << html::StartTag("li", "class='subsubentry'")
 789                                    << XHTMLStream::ESCAPE_NONE << subsub;
 790                         } else if (level == 2) {
 791                                 // there are two ways we can be here:
 792                                 // (i) we can actually be inside a sub-entry already and be about
 793                                 //     to output the first sub-sub-entry. in this case, our sub
 794                                 //     and the last sub will be the same.
 795                                 // (ii) we can just have closed a sub-entry, possibly after also
 796                                 //     closing a list of sub-sub-entries. here our sub and the last
 797                                 //     sub are different.
 798                                 // only in the latter case do we need to output the new sub-entry.
 799                                 // note that in this case, too, though, the sub-entry might already
 800                                 // have a sub-sub-entry.
 801                                 if (eit->sub != last.sub)
 802                                         xs << html::StartTag("li", "class='subentry'")
 803                                            << XHTMLStream::ESCAPE_NONE << sub;
 804                                 if (!subsub.empty()) {
 805                                         // it's actually a subsubentry, so we need to start that list
 806                                         xs << html::CR()
 807                                            << html::StartTag("ul", "class='subsubentry'")
 808                                            << html::StartTag("li", "class='subsubentry'")
 809                                            << XHTMLStream::ESCAPE_NONE << subsub;
 810                                         level = 3;
 811                                 }
 812                         } else {
 813                                 // there are also two ways we can be here:
 814                                 // (i) we can actually be inside an entry already and be about
 815                                 //     to output the first sub-entry. in this case, our main
 816                                 //     and the last main will be the same.
 817                                 // (ii) we can just have closed an entry, possibly after also
 818                                 //     closing a list of sub-entries. here our main and the last
 819                                 //     main are different.
 820                                 // only in the latter case do we need to output the new main entry.
 821                                 // note that in this case, too, though, the main entry might already
 822                                 // have a sub-entry, or even a sub-sub-entry.
 823                                 if (eit->main != last.main)
 824                                         xs << html::StartTag("li", "class='main'") << main;
 825                                 if (!sub.empty()) {
 826                                         // there's a sub-entry, too
 827                                         xs << html::CR()
 828                                            << html::StartTag("ul", "class='subentry'")
 829                                            << html::StartTag("li", "class='subentry'")
 830                                            << XHTMLStream::ESCAPE_NONE << sub;
 831                                         level = 2;
 832                                         if (!subsub.empty()) {
 833                                                 // and a sub-sub-entry
 834                                                 xs << html::CR()
 835                                                    << html::StartTag("ul", "class='subsubentry'")
 836                                                    << html::StartTag("li", "class='subsubentry'")
 837                                                    << XHTMLStream::ESCAPE_NONE << subsub;
 838                                                 level = 3;
 839                                         }
 840                                 }
 841                         }
 842                 }
 843                 // finally, then, we can output the index link itself
 844                 string const parattr = "href='#" + par.magicLabel() + "'";
 845                 xs << (entry_number == 0 ? ":" : ",");
 846                 xs << " " << html::StartTag("a", parattr)
 847                    << ++entry_number << html::EndTag("a");
 848                 last = *eit;
 849         }
 850         // now we have to close all the open levels
 851         while (level > 0) {
 852                 xs << html::EndTag("li") << html::EndTag("ul") << html::CR();
 853                 --level;
 854         }
 855         xs << html::EndTag("div") << html::CR();
 856         return ods.str();
 857 }
 858
 859 } // namespace lyx