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 "InsetList.h"
  31 #include "Intl.h"
  32 #include "Language.h"
  33 #include "Layout.h"
  34 #include "LaTeXFeatures.h"
  35 #include "Lexer.h"
  36 #include "lyxfind.h"
  37 #include "LyXRC.h"
  38 #include "MetricsInfo.h"
  39 #include "output_docbook.h"
  40 #include "output_latex.h"
  41 #include "output_xhtml.h"
  42 #include "OutputParams.h"
  43 #include "output_plaintext.h"
  44 #include "Paragraph.h"
  45 #include "ParagraphParameters.h"
  46 #include "ParIterator.h"
  47 #include "Row.h"
  48 #include "sgml.h"
  49 #include "TexRow.h"
  50 #include "texstream.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/bind.h"
  60 #include "support/convert.h"
  61 #include "support/debug.h"
  62 #include "support/gettext.h"
  63 #include "support/lassert.h"
  64 #include "support/lstrings.h"
  65 #include "support/RefChanger.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->setInsetBuffers(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         LBUFERR(!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::dimensionHelper(BufferView const & bv) const
 141 {
 142         TextMetrics const & tm = bv.textMetrics(&text_);
 143         Dimension dim = tm.dim();
 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         int const w = tm.width() + TEXT_TO_INSET_OFFSET;
 219         int const yframe = y - TEXT_TO_INSET_OFFSET - tm.ascent();
 220         int const h = tm.height() + 2 * TEXT_TO_INSET_OFFSET;
 221         int const xframe = x + TEXT_TO_INSET_OFFSET / 2;
 222         bool change_drawn = false;
 223         if (pi.full_repaint)
 224                         pi.pain.fillRectangle(xframe, yframe, w, h,
 225                                 pi.backgroundColor(this));
 226
 227         {
 228                 Changer dummy = make_change(pi.background_color,
 229                                             pi.backgroundColor(this, false));
 230                 // The change tracking cue must not be inherited
 231                 Changer dummy2 = make_change(pi.change_, Change());
 232                 tm.draw(pi, x + TEXT_TO_INSET_OFFSET, y);
 233         }
 234
 235         if (drawFrame_) {
 236                 // Change color of the frame in tracked changes, like for tabulars.
 237                 // Only do so if the color is not custom. But do so even if RowPainter
 238                 // handles the strike-through already.
 239                 Color c;
 240                 if (pi.change_.changed()
 241                     // Originally, these are the colors with role Text, from role() in
 242                     // ColorCache.cpp.  The code is duplicated to avoid depending on Qt
 243                     // types, and also maybe it need not match in the future.
 244                     && (frameColor() == Color_foreground
 245                         || frameColor() == Color_cursor
 246                         || frameColor() == Color_preview
 247                         || frameColor() == Color_tabularline
 248                         || frameColor() == Color_previewframe)) {
 249                         c = pi.change_.color();
 250                         change_drawn = true;
 251                 } else
 252                         c = frameColor();
 253                 pi.pain.rectangle(xframe, yframe, w, h, c);
 254         }
 255
 256         if (canPaintChange(*pi.base.bv) && (!change_drawn || pi.change_.deleted()))
 257                 // Do not draw the change tracking cue if already done by RowPainter and
 258                 // do not draw the cue for INSERTED if the information is already in the
 259                 // color of the frame
 260                 pi.change_.paintCue(pi, xframe, yframe, xframe + w, yframe + h);
 261 }
 262
 263
 264 void InsetText::edit(Cursor & cur, bool front, EntryDirection entry_from)
 265 {
 266         pit_type const pit = front ? 0 : paragraphs().size() - 1;
 267         pos_type pos = front ? 0 : paragraphs().back().size();
 268
 269         // if visual information is not to be ignored, move to extreme right/left
 270         if (entry_from != ENTRY_DIRECTION_IGNORE) {
 271                 Cursor temp_cur = cur;
 272                 temp_cur.pit() = pit;
 273                 temp_cur.pos() = pos;
 274                 temp_cur.posVisToRowExtremity(entry_from == ENTRY_DIRECTION_LEFT);
 275                 pos = temp_cur.pos();
 276         }
 277
 278         cur.top().setPitPos(pit, pos);
 279         cur.finishUndo();
 280 }
 281
 282
 283 Inset * InsetText::editXY(Cursor & cur, int x, int y)
 284 {
 285         return cur.bv().textMetrics(&text_).editXY(cur, x, y);
 286 }
 287
 288
 289 void InsetText::doDispatch(Cursor & cur, FuncRequest & cmd)
 290 {
 291         LYXERR(Debug::ACTION, "InsetText::doDispatch(): cmd: " << cmd);
 292
 293         // See bug #9042, for instance.
 294         if (isPassThru()) {
 295                 // Force any new text to latex_language FIXME: This
 296                 // should only be necessary in constructor, but new
 297                 // paragraphs that are created by pressing enter at
 298                 // the start of an existing paragraph get the buffer
 299                 // language and not latex_language, so we take this
 300                 // brute force approach.
 301                 cur.current_font.setLanguage(latex_language);
 302                 cur.real_current_font.setLanguage(latex_language);
 303         }
 304
 305         switch (cmd.action()) {
 306         case LFUN_PASTE:
 307         case LFUN_CLIPBOARD_PASTE:
 308         case LFUN_SELECTION_PASTE:
 309         case LFUN_PRIMARY_SELECTION_PASTE:
 310                 text_.dispatch(cur, cmd);
 311                 // If we we can only store plain text, we must reset all
 312                 // attributes.
 313                 // FIXME: Change only the pasted paragraphs
 314                 fixParagraphsFont();
 315                 break;
 316
 317         case LFUN_INSET_DISSOLVE: {
 318                 bool const main_inset = text_.isMainText();
 319                 bool const target_inset = cmd.argument().empty()
 320                         || cmd.getArg(0) == insetName(lyxCode());
 321                 // cur.inset() is the tabular when this is a single cell (bug #9954)
 322                 bool const one_cell = cur.inset().nargs() == 1;
 323
 324                 if (!main_inset && target_inset && one_cell) {
 325                         // Text::dissolveInset assumes that the cursor
 326                         // is inside the Inset.
 327                         if (&cur.inset() != this)
 328                                 cur.pushBackward(*this);
 329                         cur.beginUndoGroup();
 330                         text_.dispatch(cur, cmd);
 331                         cur.endUndoGroup();
 332                 } else
 333                         cur.undispatched();
 334                 break;
 335         }
 336
 337         default:
 338                 text_.dispatch(cur, cmd);
 339         }
 340
 341         if (!cur.result().dispatched())
 342                 Inset::doDispatch(cur, cmd);
 343 }
 344
 345
 346 bool InsetText::getStatus(Cursor & cur, FuncRequest const & cmd,
 347         FuncStatus & status) const
 348 {
 349         switch (cmd.action()) {
 350         case LFUN_INSET_DISSOLVE: {
 351                 bool const main_inset = text_.isMainText();
 352                 bool const target_inset = cmd.argument().empty()
 353                         || cmd.getArg(0) == insetName(lyxCode());
 354                 // cur.inset() is the tabular when this is a single cell (bug #9954)
 355                 bool const one_cell = cur.inset().nargs() == 1;
 356
 357                 if (target_inset)
 358                         status.setEnabled(!main_inset && one_cell);
 359                 return target_inset;
 360         }
 361
 362         case LFUN_ARGUMENT_INSERT: {
 363                 string const arg = cmd.getArg(0);
 364                 if (arg.empty()) {
 365                         status.setEnabled(false);
 366                         return true;
 367                 }
 368                 if (text_.isMainText() || !cur.paragraph().layout().args().empty())
 369                         return text_.getStatus(cur, cmd, status);
 370
 371                 Layout::LaTeXArgMap args = getLayout().args();
 372                 Layout::LaTeXArgMap::const_iterator const lait = args.find(arg);
 373                 if (lait != args.end()) {
 374                         status.setEnabled(true);
 375                         for (Paragraph const & par : paragraphs())
 376                                 for (auto const & table : par.insetList())
 377                                         if (InsetArgument const * ins = table.inset->asInsetArgument())
 378                                                 if (ins->name() == arg) {
 379                                                         // we have this already
 380                                                         status.setEnabled(false);
 381                                                         return true;
 382                                                 }
 383                 } else
 384                         status.setEnabled(false);
 385                 return true;
 386         }
 387
 388         default:
 389                 // Dispatch only to text_ if the cursor is inside
 390                 // the text_. It is not for context menus (bug 5797).
 391                 bool ret = false;
 392                 if (cur.text() == &text_)
 393                         ret = text_.getStatus(cur, cmd, status);
 394
 395                 if (!ret)
 396                         ret = Inset::getStatus(cur, cmd, status);
 397                 return ret;
 398         }
 399 }
 400
 401
 402 void InsetText::fixParagraphsFont()
 403 {
 404         Font font(inherit_font, buffer().params().language);
 405         font.setLanguage(latex_language);
 406         ParagraphList::iterator par = paragraphs().begin();
 407         ParagraphList::iterator const end = paragraphs().end();
 408         while (par != end) {
 409                 if (par->isPassThru())
 410                         par->resetFonts(font);
 411                 if (!par->allowParagraphCustomization())
 412                         par->params().clear();
 413                 ++par;
 414         }
 415 }
 416
 417
 418 void InsetText::setChange(Change const & change)
 419 {
 420         ParagraphList::iterator pit = paragraphs().begin();
 421         ParagraphList::iterator end = paragraphs().end();
 422         for (; pit != end; ++pit) {
 423                 pit->setChange(change);
 424         }
 425 }
 426
 427
 428 void InsetText::acceptChanges()
 429 {
 430         text_.acceptChanges();
 431 }
 432
 433
 434 void InsetText::rejectChanges()
 435 {
 436         text_.rejectChanges();
 437 }
 438
 439
 440 void InsetText::validate(LaTeXFeatures & features) const
 441 {
 442         features.useInsetLayout(getLayout());
 443         for (Paragraph const & p : paragraphs())
 444                 p.validate(features);
 445 }
 446
 447
 448 void InsetText::latex(otexstream & os, OutputParams const & runparams) const
 449 {
 450         // This implements the standard way of handling the LaTeX
 451         // output of a text inset, either a command or an
 452         // environment. Standard collapsible insets should not
 453         // redefine this, non-standard ones may call this.
 454         InsetLayout const & il = getLayout();
 455         if (il.forceOwnlines())
 456                 os << breakln;
 457         if (!il.latexname().empty()) {
 458                 if (il.latextype() == InsetLayout::COMMAND) {
 459                         // FIXME UNICODE
 460                         // FIXME \protect should only be used for fragile
 461                         //    commands, but we do not provide this information yet.
 462                         if (hasCProtectContent(runparams.moving_arg))
 463                                 os << "\\cprotect";
 464                         else if (runparams.moving_arg)
 465                                 os << "\\protect";
 466                         os << '\\' << from_utf8(il.latexname());
 467                         if (!il.latexargs().empty())
 468                                 getArgs(os, runparams);
 469                         if (!il.latexparam().empty())
 470                                 os << from_utf8(il.latexparam());
 471                         os << '{';
 472                 } else if (il.latextype() == InsetLayout::ENVIRONMENT) {
 473                         if (il.isDisplay())
 474                                 os << breakln;
 475                         else
 476                                 os << safebreakln;
 477                         if (runparams.lastid != -1)
 478                                 os.texrow().start(runparams.lastid,
 479                                                   runparams.lastpos);
 480                         os << "\\begin{" << from_utf8(il.latexname()) << "}";
 481                         if (!il.latexargs().empty())
 482                                 getArgs(os, runparams);
 483                         if (!il.latexparam().empty())
 484                                 os << from_utf8(il.latexparam());
 485                         os << '\n';
 486                 }
 487         } else {
 488                 if (!il.latexargs().empty())
 489                         getArgs(os, runparams);
 490                 if (!il.latexparam().empty())
 491                         os << from_utf8(il.latexparam());
 492         }
 493
 494         if (!il.leftdelim().empty())
 495                 os << il.leftdelim();
 496
 497         OutputParams rp = runparams;
 498         if (isPassThru())
 499                 rp.pass_thru = true;
 500         if (il.isNeedProtect())
 501                 rp.moving_arg = true;
 502         if (il.isNeedMBoxProtect())
 503                 ++rp.inulemcmd;
 504         if (!il.passThruChars().empty())
 505                 rp.pass_thru_chars += il.passThruChars();
 506         if (!il.newlineCmd().empty())
 507                 rp.newlinecmd = il.newlineCmd();
 508         rp.par_begin = 0;
 509         rp.par_end = paragraphs().size();
 510
 511         // Output the contents of the inset
 512         latexParagraphs(buffer(), text_, os, rp);
 513         runparams.encoding = rp.encoding;
 514         // Pass the post_macros upstream
 515         runparams.post_macro = rp.post_macro;
 516
 517         if (!il.rightdelim().empty())
 518                 os << il.rightdelim();
 519
 520         if (!il.latexname().empty()) {
 521                 if (il.latextype() == InsetLayout::COMMAND) {
 522                         os << "}";
 523                         if (!il.postcommandargs().empty())
 524                                 getArgs(os, runparams, true);
 525                 } else if (il.latextype() == InsetLayout::ENVIRONMENT) {
 526                         // A comment environment doesn't need a % before \n\end
 527                         if (il.isDisplay() || runparams.inComment)
 528                                 os << breakln;
 529                         else
 530                                 os << safebreakln;
 531                         os << "\\end{" << from_utf8(il.latexname()) << "}" << breakln;
 532                         if (!il.isDisplay())
 533                                 os.protectSpace(true);
 534                 }
 535         }
 536         if (il.forceOwnlines())
 537                 os << breakln;
 538 }
 539
 540
 541 int InsetText::plaintext(odocstringstream & os,
 542         OutputParams const & runparams, size_t max_length) const
 543 {
 544         ParagraphList::const_iterator beg = paragraphs().begin();
 545         ParagraphList::const_iterator end = paragraphs().end();
 546         ParagraphList::const_iterator it = beg;
 547         bool ref_printed = false;
 548         int len = 0;
 549         for (; it != end; ++it) {
 550                 if (it != beg) {
 551                         os << '\n';
 552                         if (runparams.linelen > 0)
 553                                 os << '\n';
 554                 }
 555                 odocstringstream oss;
 556                 writePlaintextParagraph(buffer(), *it, oss, runparams, ref_printed, max_length);
 557                 docstring const str = oss.str();
 558                 os << str;
 559                 // FIXME: len is not computed fully correctly; in principle,
 560                 // we have to count the characters after the last '\n'
 561                 len = str.size();
 562                 if (os.str().size() >= max_length)
 563                         break;
 564         }
 565
 566         return len;
 567 }
 568
 569
 570 int InsetText::docbook(odocstream & os, OutputParams const & runparams) const
 571 {
 572         ParagraphList::const_iterator const beg = paragraphs().begin();
 573
 574         if (!undefined())
 575                 sgml::openTag(os, getLayout().latexname(),
 576                               beg->getID(buffer(), runparams) + getLayout().latexparam());
 577
 578         docbookParagraphs(text_, buffer(), os, runparams);
 579
 580         if (!undefined())
 581                 sgml::closeTag(os, getLayout().latexname());
 582
 583         return 0;
 584 }
 585
 586
 587 docstring InsetText::xhtml(XHTMLStream & xs, OutputParams const & runparams) const
 588 {
 589         return insetAsXHTML(xs, runparams, WriteEverything);
 590 }
 591
 592
 593 // FIXME XHTML
 594 // There are cases where we may need to close open fonts and such
 595 // and then re-open them when we are done. This would be the case, e.g.,
 596 // if we were otherwise about to write:
 597 //              <em>word <div class='foot'>footnote text.</div> emph</em>
 598 // The problem isn't so much that the footnote text will get emphasized:
 599 // we can handle that with CSS. The problem is that this is invalid XHTML.
 600 // One solution would be to make the footnote <span>, but the problem is
 601 // completely general, and so we'd have to make absolutely everything into
 602 // span. What I think will work is to check if we're about to write "div" and,
 603 // if so, try to close fonts, etc.
 604 // There are probably limits to how well we can do here, though, and we will
 605 // have to rely upon users not putting footnotes inside noun-type insets.
 606 docstring InsetText::insetAsXHTML(XHTMLStream & xs, OutputParams const & rp,
 607                                   XHTMLOptions opts) const
 608 {
 609         // we will always want to output all our paragraphs when we are
 610         // called this way.
 611         OutputParams runparams = rp;
 612         runparams.par_begin = 0;
 613         runparams.par_end = text().paragraphs().size();
 614
 615         if (undefined()) {
 616                 xs.startDivision(false);
 617                 xhtmlParagraphs(text_, buffer(), xs, runparams);
 618                 xs.endDivision();
 619                 return docstring();
 620         }
 621
 622         InsetLayout const & il = getLayout();
 623         if (opts & WriteOuterTag)
 624                 xs << html::StartTag(il.htmltag(), il.htmlattr());
 625
 626         if ((opts & WriteLabel) && !il.counter().empty()) {
 627                 BufferParams const & bp = buffer().masterBuffer()->params();
 628                 Counters & cntrs = bp.documentClass().counters();
 629                 cntrs.step(il.counter(), OutputUpdate);
 630                 // FIXME: translate to paragraph language
 631                 if (!il.htmllabel().empty()) {
 632                         docstring const lbl =
 633                                 cntrs.counterLabel(from_utf8(il.htmllabel()), bp.language->code());
 634                         // FIXME is this check necessary?
 635                         if (!lbl.empty()) {
 636                                 xs << html::StartTag(il.htmllabeltag(), il.htmllabelattr());
 637                                 xs << lbl;
 638                                 xs << html::EndTag(il.htmllabeltag());
 639                         }
 640                 }
 641         }
 642
 643         if (opts & WriteInnerTag)
 644                 xs << html::StartTag(il.htmlinnertag(), il.htmlinnerattr());
 645
 646         // we will eventually lose information about the containing inset
 647         if (!allowMultiPar() || opts == JustText)
 648                 runparams.html_make_pars = false;
 649         if (il.isPassThru())
 650                 runparams.pass_thru = true;
 651
 652         xs.startDivision(false);
 653         xhtmlParagraphs(text_, buffer(), xs, runparams);
 654         xs.endDivision();
 655
 656         if (opts & WriteInnerTag)
 657                 xs << html::EndTag(il.htmlinnertag());
 658
 659         if (opts & WriteOuterTag)
 660                 xs << html::EndTag(il.htmltag());
 661
 662         return docstring();
 663 }
 664
 665
 666 void InsetText::getArgs(otexstream & os, OutputParams const & runparams_in,
 667                         bool const post) const
 668 {
 669         OutputParams runparams = runparams_in;
 670         runparams.local_font =
 671                 &paragraphs()[0].getFirstFontSettings(buffer().masterBuffer()->params());
 672         if (isPassThru())
 673                 runparams.pass_thru = true;
 674         if (post)
 675                 latexArgInsetsForParent(paragraphs(), os, runparams,
 676                                         getLayout().postcommandargs(), "post:");
 677         else
 678                 latexArgInsetsForParent(paragraphs(), os, runparams,
 679                                         getLayout().latexargs());
 680 }
 681
 682
 683 void InsetText::cursorPos(BufferView const & bv,
 684                 CursorSlice const & sl, bool boundary, int & x, int & y) const
 685 {
 686         x = bv.textMetrics(&text_).cursorX(sl, boundary) + TEXT_TO_INSET_OFFSET;
 687         y = bv.textMetrics(&text_).cursorY(sl, boundary);
 688 }
 689
 690
 691 void InsetText::setText(docstring const & data, Font const & font, bool trackChanges)
 692 {
 693         clear();
 694         Paragraph & first = paragraphs().front();
 695         for (unsigned int i = 0; i < data.length(); ++i)
 696                 first.insertChar(i, data[i], font, trackChanges);
 697 }
 698
 699
 700 void InsetText::setDrawFrame(bool flag)
 701 {
 702         drawFrame_ = flag;
 703 }
 704
 705
 706 ColorCode InsetText::frameColor() const
 707 {
 708         return frame_color_;
 709 }
 710
 711
 712 void InsetText::setFrameColor(ColorCode col)
 713 {
 714         frame_color_ = col;
 715 }
 716
 717
 718 void InsetText::appendParagraphs(ParagraphList & plist)
 719 {
 720         // There is little we can do here to keep track of changes.
 721         // As of 2006/10/20, appendParagraphs is used exclusively by
 722         // LyXTabular::setMultiColumn. In this context, the paragraph break
 723         // is lost irreversibly and the appended text doesn't really change
 724
 725         ParagraphList & pl = paragraphs();
 726
 727         ParagraphList::iterator pit = plist.begin();
 728         ParagraphList::iterator ins = pl.insert(pl.end(), *pit);
 729         ++pit;
 730         mergeParagraph(buffer().params(), pl,
 731                        distance(pl.begin(), ins) - 1);
 732
 733         for_each(pit, plist.end(),
 734                  bind(&ParagraphList::push_back, ref(pl), _1));
 735 }
 736
 737
 738 void InsetText::addPreview(DocIterator const & text_inset_pos,
 739         PreviewLoader & loader) const
 740 {
 741         ParagraphList::const_iterator pit = paragraphs().begin();
 742         ParagraphList::const_iterator pend = paragraphs().end();
 743         int pidx = 0;
 744
 745         DocIterator inset_pos = text_inset_pos;
 746         inset_pos.push_back(CursorSlice(*const_cast<InsetText *>(this)));
 747
 748         for (; pit != pend; ++pit, ++pidx) {
 749                 InsetList::const_iterator it  = pit->insetList().begin();
 750                 InsetList::const_iterator end = pit->insetList().end();
 751                 inset_pos.pit() = pidx;
 752                 for (; it != end; ++it) {
 753                         inset_pos.pos() = it->pos;
 754                         it->inset->addPreview(inset_pos, loader);
 755                 }
 756         }
 757 }
 758
 759
 760 ParagraphList const & InsetText::paragraphs() const
 761 {
 762         return text_.paragraphs();
 763 }
 764
 765
 766 ParagraphList & InsetText::paragraphs()
 767 {
 768         return text_.paragraphs();
 769 }
 770
 771
 772 bool InsetText::hasCProtectContent(bool const fragile) const
 773 {
 774         ParagraphList const & pars = paragraphs();
 775         pit_type pend = paragraphs().size();
 776         for (pit_type pit = 0; pit != pend; ++pit) {
 777                 Paragraph const & par = pars[pit];
 778                 if (par.needsCProtection(fragile))
 779                         return true;
 780         }
 781         return false;
 782 }
 783
 784
 785 bool InsetText::insetAllowed(InsetCode code) const
 786 {
 787         switch (code) {
 788         // Arguments and (plain) quotes are also allowed in PassThru insets
 789         case ARG_CODE:
 790         case QUOTE_CODE:
 791                 return true;
 792         default:
 793                 return !isPassThru();
 794         }
 795 }
 796
 797
 798 void InsetText::updateBuffer(ParIterator const & it, UpdateType utype)
 799 {
 800         ParIterator it2 = it;
 801         it2.forwardPos();
 802         LASSERT(&it2.inset() == this && it2.pit() == 0, return);
 803         if (producesOutput()) {
 804                 InsetLayout const & il = getLayout();
 805                 bool const save_layouts = utype == OutputUpdate && il.htmlisblock();
 806                 Counters & cnt = buffer().masterBuffer()->params().documentClass().counters();
 807                 if (save_layouts) {
 808                         // LYXERR0("Entering " << name());
 809                         cnt.clearLastLayout();
 810                         // FIXME cnt.saveLastCounter()?
 811                 }
 812                 buffer().updateBuffer(it2, utype);
 813                 if (save_layouts) {
 814                         // LYXERR0("Exiting " << name());
 815                         cnt.restoreLastLayout();
 816                         // FIXME cnt.restoreLastCounter()?
 817                 }
 818         } else {
 819                 DocumentClass const & tclass = buffer().masterBuffer()->params().documentClass();
 820                 // Note that we do not need to call:
 821                 //      tclass.counters().clearLastLayout()
 822                 // since we are saving and restoring the existing counters, etc.
 823                 Counters savecnt = tclass.counters();
 824                 tclass.counters().reset();
 825                 // we need float information even in note insets (#9760)
 826                 tclass.counters().current_float(savecnt.current_float());
 827                 tclass.counters().isSubfloat(savecnt.isSubfloat());
 828                 buffer().updateBuffer(it2, utype);
 829                 tclass.counters() = move(savecnt);
 830         }
 831 }
 832
 833
 834 void InsetText::toString(odocstream & os) const
 835 {
 836         os << text().asString(0, 1, AS_STR_LABEL | AS_STR_INSETS);
 837 }
 838
 839
 840 void InsetText::forOutliner(docstring & os, size_t const maxlen,
 841                                                         bool const shorten) const
 842 {
 843         if (!getLayout().isInToc())
 844                 return;
 845         text().forOutliner(os, maxlen, shorten);
 846 }
 847
 848
 849 void InsetText::addToToc(DocIterator const & cdit, bool output_active,
 850                                                  UpdateType utype, TocBackend & backend) const
 851 {
 852         DocIterator dit = cdit;
 853         dit.push_back(CursorSlice(const_cast<InsetText &>(*this)));
 854         iterateForToc(dit, output_active, utype, backend);
 855 }
 856
 857
 858 void InsetText::iterateForToc(DocIterator const & cdit, bool output_active,
 859                                                           UpdateType utype, TocBackend & backend) const
 860 {
 861         DocIterator dit = cdit;
 862         // This also ensures that any document has a table of contents
 863         shared_ptr<Toc> toc = backend.toc("tableofcontents");
 864
 865         BufferParams const & bufparams = buffer_->params();
 866         int const min_toclevel = bufparams.documentClass().min_toclevel();
 867         // we really should have done this before we got here, but it
 868         // can't hurt too much to do it again
 869         bool const doing_output = output_active && producesOutput();
 870
 871         // For each paragraph,
 872         // * Add a toc item for the paragraph if it is AddToToc--merging adjacent
 873         //   paragraphs as needed.
 874         // * Traverse its insets and let them add their toc items
 875         // * Compute the main table of contents (this is hardcoded)
 876         // * Add the list of changes
 877         ParagraphList const & pars = paragraphs();
 878         pit_type pend = paragraphs().size();
 879         // Record pairs {start,end} of where a toc item was opened for a paragraph
 880         // and where it must be closed
 881         stack<pair<pit_type, pit_type>> addtotoc_stack;
 882
 883         for (pit_type pit = 0; pit != pend; ++pit) {
 884                 Paragraph const & par = pars[pit];
 885                 dit.pit() = pit;
 886                 dit.pos() = 0;
 887
 888                 // Custom AddToToc in paragraph layouts (i.e. theorems)
 889                 if (par.layout().addToToc() && text().isFirstInSequence(pit)) {
 890                         pit_type end =
 891                                 openAddToTocForParagraph(pit, dit, output_active, backend);
 892                         addtotoc_stack.push({pit, end});
 893                 }
 894
 895                 // If we find an InsetArgument that is supposed to provide the TOC caption,
 896                 // we'll save it for use later.
 897                 InsetArgument const * arginset = nullptr;
 898                 for (auto const & table : par.insetList()) {
 899                         dit.pos() = table.pos;
 900                         table.inset->addToToc(dit, doing_output, utype, backend);
 901                         if (InsetArgument const * x = table.inset->asInsetArgument())
 902                                 if (x->isTocCaption())
 903                                         arginset = x;
 904                 }
 905
 906                 // End custom AddToToc in paragraph layouts
 907                 while (!addtotoc_stack.empty() && addtotoc_stack.top().second == pit) {
 908                         // execute the closing function
 909                         closeAddToTocForParagraph(addtotoc_stack.top().first,
 910                                                   addtotoc_stack.top().second, backend);
 911                         addtotoc_stack.pop();
 912                 }
 913
 914                 // now the toc entry for the paragraph in the main table of contents
 915                 int const toclevel = text().getTocLevel(pit);
 916                 if (toclevel != Layout::NOT_IN_TOC && toclevel >= min_toclevel) {
 917                         // insert this into the table of contents
 918                         docstring tocstring;
 919                         int const length = (doing_output && utype == OutputUpdate) ?
 920                                 INT_MAX : TOC_ENTRY_LENGTH;
 921                         if (arginset) {
 922                                 tocstring = par.labelString();
 923                                 if (!tocstring.empty())
 924                                         tocstring += ' ';
 925                                 arginset->text().forOutliner(tocstring, length);
 926                         } else
 927                                 par.forOutliner(tocstring, length);
 928                         dit.pos() = 0;
 929                         toc->push_back(TocItem(dit, toclevel - min_toclevel,
 930                                                tocstring, doing_output));
 931                 }
 932
 933                 // And now the list of changes.
 934                 par.addChangesToToc(dit, buffer(), doing_output, backend);
 935         }
 936 }
 937
 938
 939 pit_type InsetText::openAddToTocForParagraph(pit_type pit,
 940                                              DocIterator const & dit,
 941                                              bool output_active,
 942                                              TocBackend & backend) const
 943 {
 944         Paragraph const & par = paragraphs()[pit];
 945         TocBuilder & b = backend.builder(par.layout().tocType());
 946         docstring const label = par.labelString();
 947         b.pushItem(dit, label + (label.empty() ? "" : " "), output_active);
 948         return text().lastInSequence(pit);
 949 }
 950
 951
 952 void InsetText::closeAddToTocForParagraph(pit_type start, pit_type end,
 953                                           TocBackend & backend) const
 954 {
 955         Paragraph const & par = paragraphs()[start];
 956         TocBuilder & b = backend.builder(par.layout().tocType());
 957         if (par.layout().isTocCaption()) {
 958                 docstring str;
 959                 text().forOutliner(str, TOC_ENTRY_LENGTH, start, end);
 960                 b.argumentItem(str);
 961         }
 962         b.pop();
 963 }
 964
 965
 966 bool InsetText::notifyCursorLeaves(Cursor const & old, Cursor & cur)
 967 {
 968         if (buffer().isClean())
 969                 return Inset::notifyCursorLeaves(old, cur);
 970
 971         // find text inset in old cursor
 972         Cursor insetCur = old;
 973         int scriptSlice = insetCur.find(this);
 974         // we can try to continue here. returning true means
 975         // the cursor is "now" invalid. which it was.
 976         LASSERT(scriptSlice != -1, return true);
 977         insetCur.cutOff(scriptSlice);
 978         LASSERT(&insetCur.inset() == this, return true);
 979
 980         // update the old paragraph's words
 981         insetCur.paragraph().updateWords();
 982
 983         return Inset::notifyCursorLeaves(old, cur);
 984 }
 985
 986
 987 bool InsetText::completionSupported(Cursor const & cur) const
 988 {
 989         //LASSERT(&cur.bv().cursor().inset() == this, return false);
 990         return text_.completionSupported(cur);
 991 }
 992
 993
 994 bool InsetText::inlineCompletionSupported(Cursor const & cur) const
 995 {
 996         return completionSupported(cur);
 997 }
 998
 999
1000 bool InsetText::automaticInlineCompletion() const
1001 {
1002         return lyxrc.completion_inline_text;
1003 }
1004
1005
1006 bool InsetText::automaticPopupCompletion() const
1007 {
1008         return lyxrc.completion_popup_text;
1009 }
1010
1011
1012 bool InsetText::showCompletionCursor() const
1013 {
1014         return lyxrc.completion_cursor_text;
1015 }
1016
1017
1018 CompletionList const * InsetText::createCompletionList(Cursor const & cur) const
1019 {
1020         return completionSupported(cur) ? text_.createCompletionList(cur) : 0;
1021 }
1022
1023
1024 docstring InsetText::completionPrefix(Cursor const & cur) const
1025 {
1026         if (!completionSupported(cur))
1027                 return docstring();
1028         return text_.completionPrefix(cur);
1029 }
1030
1031
1032 bool InsetText::insertCompletion(Cursor & cur, docstring const & s,
1033         bool finished)
1034 {
1035         if (!completionSupported(cur))
1036                 return false;
1037
1038         return text_.insertCompletion(cur, s, finished);
1039 }
1040
1041
1042 void InsetText::completionPosAndDim(Cursor const & cur, int & x, int & y,
1043         Dimension & dim) const
1044 {
1045         TextMetrics const & tm = cur.bv().textMetrics(&text_);
1046         tm.completionPosAndDim(cur, x, y, dim);
1047 }
1048
1049
1050 string InsetText::contextMenu(BufferView const &, int, int) const
1051 {
1052         string context_menu = contextMenuName();
1053         if (context_menu != InsetText::contextMenuName())
1054                 context_menu += ";" + InsetText::contextMenuName();
1055         return context_menu;
1056 }
1057
1058
1059 string InsetText::contextMenuName() const
1060 {
1061         return "context-edit";
1062 }
1063
1064
1065 docstring InsetText::toolTipText(docstring prefix, size_t const len) const
1066 {
1067         OutputParams rp(&buffer().params().encoding());
1068         rp.for_tooltip = true;
1069         odocstringstream oss;
1070         oss << prefix;
1071
1072         ParagraphList::const_iterator beg = paragraphs().begin();
1073         ParagraphList::const_iterator end = paragraphs().end();
1074         ParagraphList::const_iterator it = beg;
1075         bool ref_printed = false;
1076
1077         for (; it != end; ++it) {
1078                 if (it != beg)
1079                         oss << '\n';
1080                 if ((*it).isRTL(buffer().params()))
1081                         oss << "<div dir=\"rtl\">";
1082                 writePlaintextParagraph(buffer(), *it, oss, rp, ref_printed, len);
1083                 if ((*it).isRTL(buffer().params()))
1084                         oss << "</div>";
1085                 if (oss.tellp() >= 0 && size_t(oss.tellp()) > len)
1086                         break;
1087         }
1088         docstring str = oss.str();
1089         support::truncateWithEllipsis(str, len);
1090         return str;
1091 }
1092
1093
1094 InsetText::XHTMLOptions operator|(InsetText::XHTMLOptions a1, InsetText::XHTMLOptions a2)
1095 {
1096         return static_cast<InsetText::XHTMLOptions>((int)a1 | (int)a2);
1097 }
1098
1099
1100 bool InsetText::needsCProtection(bool const maintext, bool const fragile) const
1101 {
1102         // Nested cprotect content needs \cprotect
1103         // on each level
1104         if (producesOutput() && hasCProtectContent(fragile))
1105                 return true;
1106
1107         // Environments generally need cprotection in fragile context
1108         if (fragile && getLayout().latextype() == InsetLayout::ENVIRONMENT)
1109                 return true;
1110
1111         if (!getLayout().needsCProtect())
1112                 return false;
1113
1114         // Environments and "no latex" types (e.g., knitr chunks)
1115         // need cprotection regardless the content
1116         if (!maintext && getLayout().latextype() != InsetLayout::COMMAND)
1117                 return true;
1118
1119         // If the inset does not produce output (e.g. Note or Branch),
1120         // we can ignore the contained paragraphs
1121         if (!producesOutput())
1122                 return false;
1123
1124         // Commands need cprotection if they contain specific chars
1125         int const nchars_escape = 9;
1126         static char_type const chars_escape[nchars_escape] = {
1127                 '&', '_', '$', '%', '#', '^', '{', '}', '\\'};
1128
1129         ParagraphList const & pars = paragraphs();
1130         pit_type pend = paragraphs().size();
1131
1132         for (pit_type pit = 0; pit != pend; ++pit) {
1133                 Paragraph const & par = pars[pit];
1134                 if (par.needsCProtection(fragile))
1135                         return true;
1136                 docstring const pars = par.asString();
1137                 for (int k = 0; k < nchars_escape; k++) {
1138                         if (contains(pars, chars_escape[k]))
1139                                 return true;
1140                 }
1141         }
1142         return false;
1143 }
1144
1145 } // namespace lyx