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