src/insets/InsetText.cpp

   1 /**
   2  * \file InsetText.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Jürgen Vigna
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "InsetText.h"
  14
  15 #include "insets/InsetArgument.h"
  16
  17 #include "buffer_funcs.h"
  18 #include "Buffer.h"
  19 #include "BufferParams.h"
  20 #include "BufferView.h"
  21 #include "CompletionList.h"
  22 #include "CoordCache.h"
  23 #include "Cursor.h"
  24 #include "CutAndPaste.h"
  25 #include "DispatchResult.h"
  26 #include "ErrorList.h"
  27 #include "FuncRequest.h"
  28 #include "FuncStatus.h"
  29 #include "InsetCaption.h"
  30 #include "InsetList.h"
  31 #include "Intl.h"
  32 #include "Language.h"
  33 #include "LaTeXFeatures.h"
  34 #include "Lexer.h"
  35 #include "lyxfind.h"
  36 #include "LyXRC.h"
  37 #include "MetricsInfo.h"
  38 #include "output_docbook.h"
  39 #include "output_latex.h"
  40 #include "output_xhtml.h"
  41 #include "OutputParams.h"
  42 #include "output_plaintext.h"
  43 #include "Paragraph.h"
  44 #include "ParagraphParameters.h"
  45 #include "ParIterator.h"
  46 #include "Row.h"
  47 #include "sgml.h"
  48 #include "TexRow.h"
  49 #include "TextClass.h"
  50 #include "Text.h"
  51 #include "TextMetrics.h"
  52 #include "TocBackend.h"
  53
  54 #include "frontends/alert.h"
  55 #include "frontends/Painter.h"
  56
  57 #include "support/debug.h"
  58 #include "support/gettext.h"
  59 #include "support/lstrings.h"
  60
  61 #include "support/bind.h"
  62 #include "support/lassert.h"
  63
  64 #include <algorithm>
  65
  66
  67 using namespace std;
  68 using namespace lyx::support;
  69
  70
  71 namespace lyx {
  72
  73 using graphics::PreviewLoader;
  74
  75
  76 /////////////////////////////////////////////////////////////////////
  77
  78 InsetText::InsetText(Buffer * buf, UsePlain type)
  79         : Inset(buf), drawFrame_(false), frame_color_(Color_insetframe),
  80         text_(this, type == DefaultLayout)
  81 {
  82 }
  83
  84
  85 InsetText::InsetText(InsetText const & in)
  86         : Inset(in), text_(this, in.text_)
  87 {
  88         drawFrame_ = in.drawFrame_;
  89         frame_color_ = in.frame_color_;
  90 }
  91
  92
  93 void InsetText::setBuffer(Buffer & buf)
  94 {
  95         ParagraphList::iterator end = paragraphs().end();
  96         for (ParagraphList::iterator it = paragraphs().begin(); it != end; ++it)
  97                 it->setBuffer(buf);
  98         Inset::setBuffer(buf);
  99 }
 100
 101
 102 void InsetText::clear()
 103 {
 104         ParagraphList & pars = paragraphs();
 105         LASSERT(!pars.empty(), /**/);
 106
 107         // This is a gross hack...
 108         Layout const & old_layout = pars.begin()->layout();
 109
 110         pars.clear();
 111         pars.push_back(Paragraph());
 112         pars.begin()->setInsetOwner(this);
 113         pars.begin()->setLayout(old_layout);
 114 }
 115
 116
 117 Dimension const InsetText::dimension(BufferView const & bv) const
 118 {
 119         TextMetrics const & tm = bv.textMetrics(&text_);
 120         Dimension dim = tm.dimension();
 121         dim.wid += 2 * TEXT_TO_INSET_OFFSET;
 122         dim.des += TEXT_TO_INSET_OFFSET;
 123         dim.asc += TEXT_TO_INSET_OFFSET;
 124         return dim;
 125 }
 126
 127
 128 void InsetText::write(ostream & os) const
 129 {
 130         os << "Text\n";
 131         text_.write(os);
 132 }
 133
 134
 135 void InsetText::read(Lexer & lex)
 136 {
 137         clear();
 138
 139         // delete the initial paragraph
 140         Paragraph oldpar = *paragraphs().begin();
 141         paragraphs().clear();
 142         ErrorList errorList;
 143         lex.setContext("InsetText::read");
 144         bool res = text_.read(lex, errorList, this);
 145
 146         if (!res)
 147                 lex.printError("Missing \\end_inset at this point. ");
 148
 149         // sanity check
 150         // ensure we have at least one paragraph.
 151         if (paragraphs().empty())
 152                 paragraphs().push_back(oldpar);
 153         // Force default font, if so requested
 154         // This avoids paragraphs in buffer language that would have a
 155         // foreign language after a document language change, and it ensures
 156         // that all new text in ERT and similar gets the "latex" language,
 157         // since new text inherits the language from the last position of the
 158         // existing text.  As a side effect this makes us also robust against
 159         // bugs in LyX that might lead to font changes in ERT in .lyx files.
 160         fixParagraphsFont();
 161 }
 162
 163
 164 void InsetText::metrics(MetricsInfo & mi, Dimension & dim) const
 165 {
 166         TextMetrics & tm = mi.base.bv->textMetrics(&text_);
 167
 168         //lyxerr << "InsetText::metrics: width: " << mi.base.textwidth << endl;
 169
 170         // Hand font through to contained lyxtext:
 171         tm.font_.fontInfo() = mi.base.font;
 172         mi.base.textwidth -= 2 * TEXT_TO_INSET_OFFSET;
 173
 174         // This can happen when a layout has a left and right margin,
 175         // and the view is made very narrow. We can't do better than
 176         // to draw it partly out of view (bug 5890).
 177         if (mi.base.textwidth < 1)
 178                 mi.base.textwidth = 1;
 179
 180         if (hasFixedWidth())
 181                 tm.metrics(mi, dim, mi.base.textwidth);
 182         else
 183                 tm.metrics(mi, dim);
 184         mi.base.textwidth += 2 * TEXT_TO_INSET_OFFSET;
 185         dim.asc += TEXT_TO_INSET_OFFSET;
 186         dim.des += TEXT_TO_INSET_OFFSET;
 187         dim.wid += 2 * TEXT_TO_INSET_OFFSET;
 188 }
 189
 190
 191 void InsetText::draw(PainterInfo & pi, int x, int y) const
 192 {
 193         TextMetrics & tm = pi.base.bv->textMetrics(&text_);
 194
 195         if (drawFrame_ || pi.full_repaint) {
 196                 int const w = tm.width() + TEXT_TO_INSET_OFFSET;
 197                 int const yframe = y - TEXT_TO_INSET_OFFSET - tm.ascent();
 198                 int const h = tm.height() + 2 * TEXT_TO_INSET_OFFSET;
 199                 int const xframe = x + TEXT_TO_INSET_OFFSET / 2;
 200                 if (pi.full_repaint)
 201                         pi.pain.fillRectangle(xframe, yframe, w, h,
 202                                 pi.backgroundColor(this));
 203
 204                 if (drawFrame_)
 205                         pi.pain.rectangle(xframe, yframe, w, h, frameColor());
 206         }
 207         ColorCode const old_color = pi.background_color;
 208         pi.background_color = pi.backgroundColor(this, false);
 209
 210         tm.draw(pi, x + TEXT_TO_INSET_OFFSET, y);
 211
 212         pi.background_color = old_color;
 213 }
 214
 215
 216 void InsetText::edit(Cursor & cur, bool front, EntryDirection entry_from)
 217 {
 218         pit_type const pit = front ? 0 : paragraphs().size() - 1;
 219         pos_type pos = front ? 0 : paragraphs().back().size();
 220
 221         // if visual information is not to be ignored, move to extreme right/left
 222         if (entry_from != ENTRY_DIRECTION_IGNORE) {
 223                 Cursor temp_cur = cur;
 224                 temp_cur.pit() = pit;
 225                 temp_cur.pos() = pos;
 226                 temp_cur.posVisToRowExtremity(entry_from == ENTRY_DIRECTION_LEFT);
 227                 pos = temp_cur.pos();
 228         }
 229
 230         text_.setCursor(cur.top(), pit, pos);
 231         cur.clearSelection();
 232         cur.finishUndo();
 233 }
 234
 235
 236 Inset * InsetText::editXY(Cursor & cur, int x, int y)
 237 {
 238         return cur.bv().textMetrics(&text_).editXY(cur, x, y);
 239 }
 240
 241
 242 void InsetText::doDispatch(Cursor & cur, FuncRequest & cmd)
 243 {
 244         LYXERR(Debug::ACTION, "InsetText::doDispatch()"
 245                 << " [ cmd.action() = " << cmd.action() << ']');
 246
 247         if (getLayout().isPassThru()) {
 248                 // Force any new text to latex_language FIXME: This
 249                 // should only be necessary in constructor, but new
 250                 // paragraphs that are created by pressing enter at
 251                 // the start of an existing paragraph get the buffer
 252                 // language and not latex_language, so we take this
 253                 // brute force approach.
 254                 cur.current_font.setLanguage(latex_language);
 255                 cur.real_current_font.setLanguage(latex_language);
 256         }
 257
 258         switch (cmd.action()) {
 259         case LFUN_PASTE:
 260         case LFUN_CLIPBOARD_PASTE:
 261         case LFUN_SELECTION_PASTE:
 262         case LFUN_PRIMARY_SELECTION_PASTE:
 263                 text_.dispatch(cur, cmd);
 264                 // If we we can only store plain text, we must reset all
 265                 // attributes.
 266                 // FIXME: Change only the pasted paragraphs
 267                 fixParagraphsFont();
 268                 break;
 269
 270         case LFUN_INSET_DISSOLVE: {
 271                 bool const main_inset = &buffer().inset() == this;
 272                 bool const target_inset = cmd.argument().empty()
 273                         || cmd.getArg(0) == insetName(lyxCode());
 274                 bool const one_cell = nargs() == 1;
 275
 276                 if (!main_inset && target_inset && one_cell) {
 277                         // Text::dissolveInset assumes that the cursor
 278                         // is inside the Inset.
 279                         if (&cur.inset() != this)
 280                                 cur.pushBackward(*this);
 281                         cur.beginUndoGroup();
 282                         text_.dispatch(cur, cmd);
 283                         cur.endUndoGroup();
 284                 } else
 285                         cur.undispatched();
 286                 break;
 287         }
 288
 289         default:
 290                 text_.dispatch(cur, cmd);
 291         }
 292
 293         if (!cur.result().dispatched())
 294                 Inset::doDispatch(cur, cmd);
 295 }
 296
 297
 298 bool InsetText::getStatus(Cursor & cur, FuncRequest const & cmd,
 299         FuncStatus & status) const
 300 {
 301         switch (cmd.action()) {
 302         case LFUN_INSET_DISSOLVE: {
 303                 bool const main_inset = &buffer().inset() == this;
 304                 bool const target_inset = cmd.argument().empty()
 305                         || cmd.getArg(0) == insetName(lyxCode());
 306                 bool const one_cell = nargs() == 1;
 307
 308                 if (target_inset)
 309                         status.setEnabled(!main_inset && one_cell);
 310                 return target_inset;
 311         }
 312
 313         default:
 314                 // Dispatch only to text_ if the cursor is inside
 315                 // the text_. It is not for context menus (bug 5797).
 316                 bool ret = false;
 317                 if (cur.text() == &text_)
 318                         ret = text_.getStatus(cur, cmd, status);
 319
 320                 if (!ret)
 321                         ret = Inset::getStatus(cur, cmd, status);
 322                 return ret;
 323         }
 324 }
 325
 326
 327 void InsetText::fixParagraphsFont()
 328 {
 329         Font font(inherit_font, buffer().params().language);
 330         font.setLanguage(latex_language);
 331         ParagraphList::iterator par = paragraphs().begin();
 332         ParagraphList::iterator const end = paragraphs().end();
 333         while (par != end) {
 334                 if (par->isPassThru())
 335                         par->resetFonts(font);
 336                 if (!par->allowParagraphCustomization())
 337                         par->params().clear();
 338                 ++par;
 339         }
 340 }
 341
 342
 343 void InsetText::setChange(Change const & change)
 344 {
 345         ParagraphList::iterator pit = paragraphs().begin();
 346         ParagraphList::iterator end = paragraphs().end();
 347         for (; pit != end; ++pit) {
 348                 pit->setChange(change);
 349         }
 350 }
 351
 352
 353 void InsetText::acceptChanges()
 354 {
 355         text_.acceptChanges();
 356 }
 357
 358
 359 void InsetText::rejectChanges()
 360 {
 361         text_.rejectChanges();
 362 }
 363
 364
 365 void InsetText::validate(LaTeXFeatures & features) const
 366 {
 367         features.useInsetLayout(getLayout());
 368         for_each(paragraphs().begin(), paragraphs().end(),
 369                  bind(&Paragraph::validate, _1, ref(features)));
 370 }
 371
 372
 373 void InsetText::latex(otexstream & os, OutputParams const & runparams) const
 374 {
 375         // This implements the standard way of handling the LaTeX
 376         // output of a text inset, either a command or an
 377         // environment. Standard collapsable insets should not
 378         // redefine this, non-standard ones may call this.
 379         InsetLayout const & il = getLayout();
 380         if (!il.latexname().empty()) {
 381                 if (il.latextype() == InsetLayout::COMMAND) {
 382                         // FIXME UNICODE
 383                         if (runparams.moving_arg)
 384                                 os << "\\protect";
 385                         os << '\\' << from_utf8(il.latexname());
 386                         if (!il.latexparam().empty())
 387                                 os << from_utf8(il.latexparam());
 388                         os << '{';
 389                 } else if (il.latextype() == InsetLayout::ENVIRONMENT) {
 390                         if (il.isDisplay())
 391                             os << breakln;
 392                         else
 393                             os << safebreakln;
 394                         os << "\\begin{" << from_utf8(il.latexname()) << "}\n";
 395                         if (!il.latexparam().empty())
 396                                 os << from_utf8(il.latexparam());
 397                 }
 398         }
 399         OutputParams rp = runparams;
 400         if (il.isPassThru())
 401                 rp.pass_thru = true;
 402         if (il.isNeedProtect())
 403                 rp.moving_arg = true;
 404         rp.par_begin = 0;
 405         rp.par_end = paragraphs().size();
 406
 407         // Output the contents of the inset
 408         latexParagraphs(buffer(), text_, os, rp);
 409         runparams.encoding = rp.encoding;
 410
 411         if (!il.latexname().empty()) {
 412                 if (il.latextype() == InsetLayout::COMMAND) {
 413                         os << "}";
 414                 } else if (il.latextype() == InsetLayout::ENVIRONMENT) {
 415                         // A comment environment doesn't need a % before \n\end
 416                         if (il.isDisplay() || runparams.inComment)
 417                             os << breakln;
 418                         else
 419                             os << safebreakln;
 420                         os << "\\end{" << from_utf8(il.latexname()) << "}\n";
 421                         if (!il.isDisplay())
 422                                 os.protectSpace(true);
 423                 }
 424         }
 425 }
 426
 427
 428 int InsetText::plaintext(odocstream & os, OutputParams const & runparams) const
 429 {
 430         ParagraphList::const_iterator beg = paragraphs().begin();
 431         ParagraphList::const_iterator end = paragraphs().end();
 432         ParagraphList::const_iterator it = beg;
 433         bool ref_printed = false;
 434         int len = 0;
 435         for (; it != end; ++it) {
 436                 if (it != beg) {
 437                         os << '\n';
 438                         if (runparams.linelen > 0)
 439                                 os << '\n';
 440                 }
 441                 odocstringstream oss;
 442                 writePlaintextParagraph(buffer(), *it, oss, runparams, ref_printed);
 443                 docstring const str = oss.str();
 444                 os << str;
 445                 // FIXME: len is not computed fully correctly; in principle,
 446                 // we have to count the characters after the last '\n'
 447                 len = str.size();
 448         }
 449
 450         return len;
 451 }
 452
 453
 454 int InsetText::docbook(odocstream & os, OutputParams const & runparams) const
 455 {
 456         ParagraphList::const_iterator const beg = paragraphs().begin();
 457
 458         if (!undefined())
 459                 sgml::openTag(os, getLayout().latexname(),
 460                               beg->getID(buffer(), runparams) + getLayout().latexparam());
 461
 462         docbookParagraphs(text_, buffer(), os, runparams);
 463
 464         if (!undefined())
 465                 sgml::closeTag(os, getLayout().latexname());
 466
 467         return 0;
 468 }
 469
 470
 471 docstring InsetText::xhtml(XHTMLStream & xs, OutputParams const & runparams) const
 472 {
 473         return insetAsXHTML(xs, runparams, WriteEverything);
 474 }
 475
 476
 477 // FIXME XHTML
 478 // There are cases where we may need to close open fonts and such
 479 // and then re-open them when we are done. This would be the case, e.g.,
 480 // if we were otherwise about to write:
 481 //              <em>word <div class='foot'>footnote text.</div> emph</em>
 482 // The problem isn't so much that the footnote text will get emphasized:
 483 // we can handle that with CSS. The problem is that this is invalid XHTML.
 484 // One solution would be to make the footnote <span>, but the problem is
 485 // completely general, and so we'd have to make absolutely everything into
 486 // span. What I think will work is to check if we're about to write "div" and,
 487 // if so, try to close fonts, etc.
 488 // There are probably limits to how well we can do here, though, and we will
 489 // have to rely upon users not putting footnotes inside noun-type insets.
 490 docstring InsetText::insetAsXHTML(XHTMLStream & xs, OutputParams const & runparams,
 491                                   XHTMLOptions opts) const
 492 {
 493         if (undefined()) {
 494                 xhtmlParagraphs(text_, buffer(), xs, runparams);
 495                 return docstring();
 496         }
 497
 498         InsetLayout const & il = getLayout();
 499         if (opts & WriteOuterTag)
 500                 xs << html::StartTag(il.htmltag(), il.htmlattr());
 501         if ((opts & WriteLabel) && !il.counter().empty()) {
 502                 BufferParams const & bp = buffer().masterBuffer()->params();
 503                 Counters & cntrs = bp.documentClass().counters();
 504                 cntrs.step(il.counter(), OutputUpdate);
 505                 // FIXME: translate to paragraph language
 506                 if (!il.htmllabel().empty()) {
 507                         docstring const lbl =
 508                                 cntrs.counterLabel(from_utf8(il.htmllabel()), bp.language->code());
 509                         // FIXME is this check necessary?
 510                         if (!lbl.empty()) {
 511                                 xs << html::StartTag(il.htmllabeltag(), il.htmllabelattr());
 512                                 xs << lbl;
 513                                 xs << html::EndTag(il.htmllabeltag());
 514                         }
 515                 }
 516         }
 517
 518         if (opts & WriteInnerTag)
 519                 xs << html::StartTag(il.htmlinnertag(), il.htmlinnerattr());
 520         OutputParams ours = runparams;
 521         if (!il.isMultiPar() || opts == JustText)
 522                 ours.html_make_pars = false;
 523         xhtmlParagraphs(text_, buffer(), xs, ours);
 524         if (opts & WriteInnerTag)
 525                 xs << html::EndTag(il.htmlinnertag());
 526         if (opts & WriteOuterTag)
 527                 xs << html::EndTag(il.htmltag());
 528         return docstring();
 529 }
 530
 531
 532 void InsetText::cursorPos(BufferView const & bv,
 533                 CursorSlice const & sl, bool boundary, int & x, int & y) const
 534 {
 535         x = bv.textMetrics(&text_).cursorX(sl, boundary) + TEXT_TO_INSET_OFFSET;
 536         y = bv.textMetrics(&text_).cursorY(sl, boundary);
 537 }
 538
 539
 540 void InsetText::setText(docstring const & data, Font const & font, bool trackChanges)
 541 {
 542         clear();
 543         Paragraph & first = paragraphs().front();
 544         for (unsigned int i = 0; i < data.length(); ++i)
 545                 first.insertChar(i, data[i], font, trackChanges);
 546 }
 547
 548
 549 void InsetText::setAutoBreakRows(bool flag)
 550 {
 551         if (flag == text_.autoBreakRows_)
 552                 return;
 553
 554         text_.autoBreakRows_ = flag;
 555         if (flag)
 556                 return;
 557
 558         // remove previously existing newlines
 559         ParagraphList::iterator it = paragraphs().begin();
 560         ParagraphList::iterator end = paragraphs().end();
 561         for (; it != end; ++it)
 562                 for (int i = 0; i < it->size(); ++i)
 563                         if (it->isNewline(i))
 564                                 // do not track the change, because the user
 565                                 // is not allowed to revert/reject it
 566                                 it->eraseChar(i, false);
 567 }
 568
 569
 570 void InsetText::setDrawFrame(bool flag)
 571 {
 572         drawFrame_ = flag;
 573 }
 574
 575
 576 ColorCode InsetText::frameColor() const
 577 {
 578         return frame_color_;
 579 }
 580
 581
 582 void InsetText::setFrameColor(ColorCode col)
 583 {
 584         frame_color_ = col;
 585 }
 586
 587
 588 void InsetText::appendParagraphs(ParagraphList & plist)
 589 {
 590         // There is little we can do here to keep track of changes.
 591         // As of 2006/10/20, appendParagraphs is used exclusively by
 592         // LyXTabular::setMultiColumn. In this context, the paragraph break
 593         // is lost irreversibly and the appended text doesn't really change
 594
 595         ParagraphList & pl = paragraphs();
 596
 597         ParagraphList::iterator pit = plist.begin();
 598         ParagraphList::iterator ins = pl.insert(pl.end(), *pit);
 599         ++pit;
 600         mergeParagraph(buffer().params(), pl,
 601                        distance(pl.begin(), ins) - 1);
 602
 603         for_each(pit, plist.end(),
 604                  bind(&ParagraphList::push_back, ref(pl), _1));
 605 }
 606
 607
 608 void InsetText::addPreview(DocIterator const & text_inset_pos,
 609         PreviewLoader & loader) const
 610 {
 611         ParagraphList::const_iterator pit = paragraphs().begin();
 612         ParagraphList::const_iterator pend = paragraphs().end();
 613         int pidx = 0;
 614
 615         DocIterator inset_pos = text_inset_pos;
 616         inset_pos.push_back(CursorSlice(*const_cast<InsetText *>(this)));
 617
 618         for (; pit != pend; ++pit, ++pidx) {
 619                 InsetList::const_iterator it  = pit->insetList().begin();
 620                 InsetList::const_iterator end = pit->insetList().end();
 621                 inset_pos.pit() = pidx;
 622                 for (; it != end; ++it) {
 623                         inset_pos.pos() = it->pos;
 624                         it->inset->addPreview(inset_pos, loader);
 625                 }
 626         }
 627 }
 628
 629
 630 ParagraphList const & InsetText::paragraphs() const
 631 {
 632         return text_.paragraphs();
 633 }
 634
 635
 636 ParagraphList & InsetText::paragraphs()
 637 {
 638         return text_.paragraphs();
 639 }
 640
 641
 642 void InsetText::updateBuffer(ParIterator const & it, UpdateType utype)
 643 {
 644         ParIterator it2 = it;
 645         it2.forwardPos();
 646         LASSERT(&it2.inset() == this && it2.pit() == 0, return);
 647         if (producesOutput()) {
 648                 InsetLayout const & il = getLayout();
 649                 bool const save_layouts = utype == OutputUpdate && il.htmlisblock();
 650                 Counters & cnt = buffer().masterBuffer()->params().documentClass().counters();
 651                 if (save_layouts) {
 652                         // LYXERR0("Entering " << name());
 653                         cnt.clearLastLayout();
 654                         // FIXME cnt.saveLastCounter()?
 655                 }
 656                 buffer().updateBuffer(it2, utype);
 657                 if (save_layouts) {
 658                         // LYXERR0("Exiting " << name());
 659                         cnt.restoreLastLayout();
 660                         // FIXME cnt.restoreLastCounter()?
 661                 }
 662         } else {
 663                 DocumentClass const & tclass = buffer().masterBuffer()->params().documentClass();
 664                 // Note that we do not need to call:
 665                 //      tclass.counters().clearLastLayout()
 666                 // since we are saving and restoring the existing counters, etc.
 667                 Counters const savecnt = tclass.counters();
 668                 tclass.counters().reset();
 669                 buffer().updateBuffer(it2, utype);
 670                 tclass.counters() = savecnt;
 671         }
 672 }
 673
 674
 675 void InsetText::toString(odocstream & os) const
 676 {
 677         os << text().asString(0, 1, AS_STR_LABEL | AS_STR_INSETS);
 678 }
 679
 680
 681 void InsetText::forToc(docstring & os, size_t maxlen) const
 682 {
 683         if (!getLayout().isInToc())
 684                 return;
 685         text().forToc(os, maxlen, false);
 686 }
 687
 688
 689 void InsetText::addToToc(DocIterator const & cdit) const
 690 {
 691         DocIterator dit = cdit;
 692         dit.push_back(CursorSlice(const_cast<InsetText &>(*this)));
 693         Toc & toc = buffer().tocBackend().toc("tableofcontents");
 694
 695         BufferParams const & bufparams = buffer_->params();
 696         int const min_toclevel = bufparams.documentClass().min_toclevel();
 697
 698         // For each paragraph, traverse its insets and let them add
 699         // their toc items
 700         ParagraphList const & pars = paragraphs();
 701         pit_type pend = paragraphs().size();
 702         for (pit_type pit = 0; pit != pend; ++pit) {
 703                 Paragraph const & par = pars[pit];
 704                 dit.pit() = pit;
 705                 // if we find an optarg, we'll save it for use later.
 706                 InsetText const * arginset = 0;
 707                 InsetList::const_iterator it  = par.insetList().begin();
 708                 InsetList::const_iterator end = par.insetList().end();
 709                 for (; it != end; ++it) {
 710                         Inset & inset = *it->inset;
 711                         dit.pos() = it->pos;
 712                         //lyxerr << (void*)&inset << " code: " << inset.lyxCode() << std::endl;
 713                         inset.addToToc(dit);
 714                         if (inset.lyxCode() == ARG_CODE)
 715                                 arginset = inset.asInsetText();
 716                 }
 717                 // now the toc entry for the paragraph
 718                 int const toclevel = par.layout().toclevel;
 719                 if (toclevel != Layout::NOT_IN_TOC && toclevel >= min_toclevel) {
 720                         // insert this into the table of contents
 721                         docstring tocstring;
 722                         if (arginset) {
 723                                 tocstring = par.labelString();
 724                                 if (!tocstring.empty())
 725                                         tocstring += ' ';
 726                                 arginset->text().forToc(tocstring, TOC_ENTRY_LENGTH);
 727                         } else
 728                                 par.forToc(tocstring, TOC_ENTRY_LENGTH);
 729                         dit.pos() = 0;
 730                         toc.push_back(TocItem(dit, toclevel - min_toclevel,
 731                                 tocstring, tocstring));
 732                 }
 733
 734                 // And now the list of changes.
 735                 par.addChangesToToc(dit, buffer());
 736         }
 737 }
 738
 739
 740 bool InsetText::notifyCursorLeaves(Cursor const & old, Cursor & cur)
 741 {
 742         if (buffer().isClean())
 743                 return Inset::notifyCursorLeaves(old, cur);
 744
 745         // find text inset in old cursor
 746         Cursor insetCur = old;
 747         int scriptSlice = insetCur.find(this);
 748         LASSERT(scriptSlice != -1, /**/);
 749         insetCur.cutOff(scriptSlice);
 750         LASSERT(&insetCur.inset() == this, /**/);
 751
 752         // update the old paragraph's words
 753         insetCur.paragraph().updateWords();
 754
 755         return Inset::notifyCursorLeaves(old, cur);
 756 }
 757
 758
 759 bool InsetText::completionSupported(Cursor const & cur) const
 760 {
 761         //LASSERT(&cur.bv().cursor().inset() != this, return false);
 762         return text_.completionSupported(cur);
 763 }
 764
 765
 766 bool InsetText::inlineCompletionSupported(Cursor const & cur) const
 767 {
 768         return completionSupported(cur);
 769 }
 770
 771
 772 bool InsetText::automaticInlineCompletion() const
 773 {
 774         return lyxrc.completion_inline_text;
 775 }
 776
 777
 778 bool InsetText::automaticPopupCompletion() const
 779 {
 780         return lyxrc.completion_popup_text;
 781 }
 782
 783
 784 bool InsetText::showCompletionCursor() const
 785 {
 786         return lyxrc.completion_cursor_text;
 787 }
 788
 789
 790 CompletionList const * InsetText::createCompletionList(Cursor const & cur) const
 791 {
 792         return completionSupported(cur) ? text_.createCompletionList(cur) : 0;
 793 }
 794
 795
 796 docstring InsetText::completionPrefix(Cursor const & cur) const
 797 {
 798         if (!completionSupported(cur))
 799                 return docstring();
 800         return text_.completionPrefix(cur);
 801 }
 802
 803
 804 bool InsetText::insertCompletion(Cursor & cur, docstring const & s,
 805         bool finished)
 806 {
 807         if (!completionSupported(cur))
 808                 return false;
 809
 810         return text_.insertCompletion(cur, s, finished);
 811 }
 812
 813
 814 void InsetText::completionPosAndDim(Cursor const & cur, int & x, int & y,
 815         Dimension & dim) const
 816 {
 817         TextMetrics const & tm = cur.bv().textMetrics(&text_);
 818         tm.completionPosAndDim(cur, x, y, dim);
 819 }
 820
 821
 822 docstring InsetText::contextMenu(BufferView const &, int, int) const
 823 {
 824         docstring context_menu = contextMenuName();
 825         if (context_menu != InsetText::contextMenuName())
 826                 context_menu += ";" + InsetText::contextMenuName();
 827         return context_menu;
 828 }
 829
 830
 831 docstring InsetText::contextMenuName() const
 832 {
 833         return from_ascii("context-edit");
 834 }
 835
 836
 837 docstring InsetText::toolTipText(docstring prefix,
 838                 size_t numlines, size_t len) const
 839 {
 840         size_t const max_length = numlines * len;
 841         OutputParams rp(&buffer().params().encoding());
 842         odocstringstream oss;
 843         oss << prefix;
 844
 845         ParagraphList::const_iterator beg = paragraphs().begin();
 846         ParagraphList::const_iterator end = paragraphs().end();
 847         ParagraphList::const_iterator it = beg;
 848         bool ref_printed = false;
 849         docstring str;
 850
 851         for (; it != end; ++it) {
 852                 if (it != beg)
 853                         oss << '\n';
 854                 writePlaintextParagraph(buffer(), *it, oss, rp, ref_printed);
 855                 str = oss.str();
 856                 if (str.length() > max_length)
 857                         break;
 858         }
 859         return support::wrapParas(str, 4, len, numlines);
 860 }
 861
 862
 863 InsetCaption const * InsetText::getCaptionInset() const
 864 {
 865         ParagraphList::const_iterator pit = paragraphs().begin();
 866         for (; pit != paragraphs().end(); ++pit) {
 867                 InsetList::const_iterator it = pit->insetList().begin();
 868                 for (; it != pit->insetList().end(); ++it) {
 869                         Inset & inset = *it->inset;
 870                         if (inset.lyxCode() == CAPTION_CODE) {
 871                                 InsetCaption const * ins =
 872                                         static_cast<InsetCaption const *>(it->inset);
 873                                 return ins;
 874                         }
 875                 }
 876         }
 877         return 0;
 878 }
 879
 880
 881 docstring InsetText::getCaptionText(OutputParams const & runparams) const
 882 {
 883         InsetCaption const * ins = getCaptionInset();
 884         if (ins == 0)
 885                 return docstring();
 886
 887         odocstringstream ods;
 888         ins->getCaptionAsPlaintext(ods, runparams);
 889         return ods.str();
 890 }
 891
 892
 893 docstring InsetText::getCaptionHTML(OutputParams const & runparams) const
 894 {
 895         InsetCaption const * ins = getCaptionInset();
 896         if (ins == 0)
 897                 return docstring();
 898
 899         odocstringstream ods;
 900         XHTMLStream xs(ods);
 901         docstring def = ins->getCaptionAsHTML(xs, runparams);
 902         if (!def.empty())
 903                 // should already have been escaped
 904                 xs << XHTMLStream::ESCAPE_NONE << def << '\n';
 905         return ods.str();
 906 }
 907
 908
 909 InsetText::XHTMLOptions operator|(InsetText::XHTMLOptions a1, InsetText::XHTMLOptions a2)
 910 {
 911         return static_cast<InsetText::XHTMLOptions>((int)a1 | (int)a2);
 912 }
 913
 914 } // namespace lyx