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