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