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         // Start outputting this inset.
 625         if (opts & WriteOuterTag) {
 626                 if (!il.docbookwrappertag().empty() && il.docbookwrappertag() != "NONE" && il.docbookwrappertag() != "IGNORE")
 627                         xml::openTag(xs, il.docbookwrappertag(), il.docbookwrapperattr(), il.docbookwrappertagtype());
 628
 629                 if (!il.docbooktag().empty() && il.docbooktag() != "NONE" && il.docbooktag() != "IGNORE") {
 630                         docstring attrs = docstring();
 631                         if (!il.docbookattr().empty())
 632                                 attrs += from_ascii(il.docbookattr());
 633                         if (il.docbooktag() == "link")
 634                                 attrs += from_ascii(" xlink:href=\"") + text_.asString() + from_ascii("\"");
 635                         xml::openTag(xs, il.docbooktag(), attrs, il.docbooktagtype());
 636                 }
 637
 638                 if (!il.docbookitemwrappertag().empty() && il.docbookitemwrappertag() != "NONE" && il.docbookitemwrappertag() != "IGNORE")
 639                         xml::openTag(xs, il.docbookitemwrappertag(), il.docbookitemwrapperattr(), il.docbookitemwrappertagtype());
 640
 641                 if (!il.docbookitemtag().empty() && il.docbookitemtag() != "NONE" && il.docbookitemtag() != "IGNORE")
 642                         xml::openTag(xs, il.docbookitemtag(), il.docbookitemattr(), il.docbookitemtagtype());
 643         }
 644
 645         // No need for labels that are generated from counters. They should be handled by the external DocBook processor.
 646
 647         // With respect to XHTML, paragraphs are still allowed here.
 648         if (!allowMultiPar())
 649                 runparams.docbook_make_pars = false;
 650         if (il.isPassThru())
 651                 runparams.pass_thru = true;
 652
 653         xs.startDivision(false);
 654         docbookParagraphs(text_, buffer(), xs, runparams);
 655         xs.endDivision();
 656
 657         if (opts & WriteOuterTag) {
 658                 if (!il.docbookitemtag().empty() && il.docbookitemtag() != "NONE" && il.docbookitemtag() != "IGNORE")
 659                         xml::closeTag(xs, il.docbookitemtag(), il.docbookitemtagtype());
 660
 661                 if (!il.docbookitemwrappertag().empty() && il.docbookitemwrappertag() != "NONE" && il.docbookitemwrappertag() != "IGNORE")
 662                         xml::closeTag(xs, il.docbookitemwrappertag(), il.docbookitemwrappertagtype());
 663
 664                 if (!il.docbooktag().empty() && il.docbooktag() != "NONE" && il.docbooktag() != "IGNORE")
 665                         xml::closeTag(xs, il.docbooktag(), il.docbooktagtype());
 666
 667                 if (!il.docbookwrappertag().empty() && il.docbookwrappertag() != "NONE" && il.docbookwrappertag() != "IGNORE")
 668                         xml::closeTag(xs, il.docbookwrappertag(), il.docbookwrappertagtype());
 669         }
 670 }
 671
 672
 673 docstring InsetText::xhtml(XMLStream & xs, OutputParams const & runparams) const
 674 {
 675         return insetAsXHTML(xs, runparams, WriteEverything);
 676 }
 677
 678
 679 // FIXME XHTML
 680 // There are cases where we may need to close open fonts and such
 681 // and then re-open them when we are done. This would be the case, e.g.,
 682 // if we were otherwise about to write:
 683 //              <em>word <div class='foot'>footnote text.</div> emph</em>
 684 // The problem isn't so much that the footnote text will get emphasized:
 685 // we can handle that with CSS. The problem is that this is invalid XHTML.
 686 // One solution would be to make the footnote <span>, but the problem is
 687 // completely general, and so we'd have to make absolutely everything into
 688 // span. What I think will work is to check if we're about to write "div" and,
 689 // if so, try to close fonts, etc.
 690 // There are probably limits to how well we can do here, though, and we will
 691 // have to rely upon users not putting footnotes inside noun-type insets.
 692 docstring InsetText::insetAsXHTML(XMLStream & xs, OutputParams const & rp,
 693                                   XHTMLOptions opts) const
 694 {
 695         // we will always want to output all our paragraphs when we are
 696         // called this way.
 697         OutputParams runparams = rp;
 698         runparams.par_begin = 0;
 699         runparams.par_end = text().paragraphs().size();
 700
 701         if (undefined()) {
 702                 xs.startDivision(false);
 703                 xhtmlParagraphs(text_, buffer(), xs, runparams);
 704                 xs.endDivision();
 705                 return docstring();
 706         }
 707
 708         InsetLayout const & il = getLayout();
 709         if (opts & WriteOuterTag)
 710                 xs << xml::StartTag(il.htmltag(), il.htmlattr());
 711
 712         if ((opts & WriteLabel) && !il.counter().empty()) {
 713                 BufferParams const & bp = buffer().masterBuffer()->params();
 714                 Counters & cntrs = bp.documentClass().counters();
 715                 cntrs.step(il.counter(), OutputUpdate);
 716                 // FIXME: translate to paragraph language
 717                 if (!il.htmllabel().empty()) {
 718                         docstring const lbl =
 719                                 cntrs.counterLabel(from_utf8(il.htmllabel()), bp.language->code());
 720                         // FIXME is this check necessary?
 721                         if (!lbl.empty()) {
 722                                 xs << xml::StartTag(il.htmllabeltag(), il.htmllabelattr());
 723                                 xs << lbl;
 724                                 xs << xml::EndTag(il.htmllabeltag());
 725                         }
 726                 }
 727         }
 728
 729         if (opts & WriteInnerTag)
 730                 xs << xml::StartTag(il.htmlinnertag(), il.htmlinnerattr());
 731
 732         // we will eventually lose information about the containing inset
 733         if (!allowMultiPar() || opts == JustText)
 734                 runparams.html_make_pars = false;
 735         if (il.isPassThru())
 736                 runparams.pass_thru = true;
 737
 738         xs.startDivision(false);
 739         xhtmlParagraphs(text_, buffer(), xs, runparams);
 740         xs.endDivision();
 741
 742         if (opts & WriteInnerTag)
 743                 xs << xml::EndTag(il.htmlinnertag());
 744
 745         if (opts & WriteOuterTag)
 746                 xs << xml::EndTag(il.htmltag());
 747
 748         return docstring();
 749 }
 750
 751
 752 void InsetText::getArgs(otexstream & os, OutputParams const & runparams_in,
 753                         bool const post) const
 754 {
 755         OutputParams runparams = runparams_in;
 756         runparams.local_font =
 757                 &paragraphs()[0].getFirstFontSettings(buffer().masterBuffer()->params());
 758         if (isPassThru())
 759                 runparams.pass_thru = true;
 760         if (post)
 761                 latexArgInsetsForParent(paragraphs(), os, runparams,
 762                                         getLayout().postcommandargs(), "post:");
 763         else
 764                 latexArgInsetsForParent(paragraphs(), os, runparams,
 765                                         getLayout().latexargs());
 766 }
 767
 768
 769 void InsetText::cursorPos(BufferView const & bv,
 770                 CursorSlice const & sl, bool boundary, int & x, int & y) const
 771 {
 772         x = bv.textMetrics(&text_).cursorX(sl, boundary) + leftOffset(&bv);
 773         y = bv.textMetrics(&text_).cursorY(sl, boundary);
 774 }
 775
 776
 777 void InsetText::setText(docstring const & data, Font const & font, bool trackChanges)
 778 {
 779         clear();
 780         Paragraph & first = paragraphs().front();
 781         for (unsigned int i = 0; i < data.length(); ++i)
 782                 first.insertChar(i, data[i], font, trackChanges);
 783 }
 784
 785
 786 void InsetText::setDrawFrame(bool flag)
 787 {
 788         drawFrame_ = flag;
 789 }
 790
 791
 792 ColorCode InsetText::frameColor() const
 793 {
 794         return frame_color_;
 795 }
 796
 797
 798 void InsetText::setFrameColor(ColorCode col)
 799 {
 800         frame_color_ = col;
 801 }
 802
 803
 804 void InsetText::appendParagraphs(ParagraphList & plist)
 805 {
 806         // There is little we can do here to keep track of changes.
 807         // As of 2006/10/20, appendParagraphs is used exclusively by
 808         // LyXTabular::setMultiColumn. In this context, the paragraph break
 809         // is lost irreversibly and the appended text doesn't really change
 810
 811         ParagraphList & pl = paragraphs();
 812
 813         ParagraphList::iterator pit = plist.begin();
 814         ParagraphList::iterator ins = pl.insert(pl.end(), *pit);
 815         ++pit;
 816         mergeParagraph(buffer().params(), pl,
 817                        distance(pl.begin(), ins) - 1);
 818
 819         ParagraphList::iterator const pend = plist.end();
 820         for (; pit != pend; ++pit)
 821                 pl.push_back(*pit);
 822 }
 823
 824
 825 void InsetText::addPreview(DocIterator const & text_inset_pos,
 826         PreviewLoader & loader) const
 827 {
 828         ParagraphList::const_iterator pit = paragraphs().begin();
 829         ParagraphList::const_iterator pend = paragraphs().end();
 830         int pidx = 0;
 831
 832         DocIterator inset_pos = text_inset_pos;
 833         inset_pos.push_back(CursorSlice(*const_cast<InsetText *>(this)));
 834
 835         for (; pit != pend; ++pit, ++pidx) {
 836                 InsetList::const_iterator it  = pit->insetList().begin();
 837                 InsetList::const_iterator end = pit->insetList().end();
 838                 inset_pos.pit() = pidx;
 839                 for (; it != end; ++it) {
 840                         inset_pos.pos() = it->pos;
 841                         it->inset->addPreview(inset_pos, loader);
 842                 }
 843         }
 844 }
 845
 846
 847 ParagraphList const & InsetText::paragraphs() const
 848 {
 849         return text_.paragraphs();
 850 }
 851
 852
 853 ParagraphList & InsetText::paragraphs()
 854 {
 855         return text_.paragraphs();
 856 }
 857
 858
 859 bool InsetText::hasCProtectContent(bool fragile) const
 860 {
 861         fragile |= getLayout().isNeedProtect();
 862         ParagraphList const & pars = paragraphs();
 863         pit_type pend = pit_type(paragraphs().size());
 864         for (pit_type pit = 0; pit != pend; ++pit) {
 865                 Paragraph const & par = pars[size_type(pit)];
 866                 if (par.needsCProtection(fragile))
 867                         return true;
 868         }
 869         return false;
 870 }
 871
 872
 873 bool InsetText::insetAllowed(InsetCode code) const
 874 {
 875         switch (code) {
 876         // Arguments and (plain) quotes are also allowed in PassThru insets
 877         case ARG_CODE:
 878         case QUOTE_CODE:
 879                 return true;
 880         default:
 881                 return !isPassThru();
 882         }
 883 }
 884
 885
 886 void InsetText::updateBuffer(ParIterator const & it, UpdateType utype, bool const deleted)
 887 {
 888         ParIterator it2 = it;
 889         it2.forwardPos();
 890         LASSERT(&it2.inset() == this && it2.pit() == 0, return);
 891         if (producesOutput()) {
 892                 InsetLayout const & il = getLayout();
 893                 bool const save_layouts = utype == OutputUpdate && il.htmlisblock();
 894                 Counters & cnt = buffer().masterBuffer()->params().documentClass().counters();
 895                 if (save_layouts) {
 896                         // LYXERR0("Entering " << name());
 897                         cnt.clearLastLayout();
 898                         // FIXME cnt.saveLastCounter()?
 899                 }
 900                 buffer().updateBuffer(it2, utype, deleted);
 901                 if (save_layouts) {
 902                         // LYXERR0("Exiting " << name());
 903                         cnt.restoreLastLayout();
 904                         // FIXME cnt.restoreLastCounter()?
 905                 }
 906                 // Record in this inset is embedded in a title layout
 907                 // This is needed to decide when \maketitle is output.
 908                 intitle_context_ = it.paragraph().layout().intitle;
 909                 // Also check embedding layouts
 910                 size_t const n = it.depth();
 911                 for (size_t i = 0; i < n; ++i) {
 912                         if (it[i].paragraph().layout().intitle) {
 913                                 intitle_context_ = true;
 914                                 break;
 915                         }
 916                 }
 917         } else {
 918                 DocumentClass const & tclass = buffer().masterBuffer()->params().documentClass();
 919                 // Note that we do not need to call:
 920                 //      tclass.counters().clearLastLayout()
 921                 // since we are saving and restoring the existing counters, etc.
 922                 Counters savecnt = tclass.counters();
 923                 tclass.counters().reset();
 924                 // we need float information even in note insets (#9760)
 925                 tclass.counters().current_float(savecnt.current_float());
 926                 tclass.counters().isSubfloat(savecnt.isSubfloat());
 927                 buffer().updateBuffer(it2, utype, deleted);
 928                 tclass.counters() = move(savecnt);
 929         }
 930 }
 931
 932
 933 void InsetText::toString(odocstream & os) const
 934 {
 935         os << text().asString(0, 1, AS_STR_LABEL | AS_STR_INSETS);
 936 }
 937
 938
 939 void InsetText::forOutliner(docstring & os, size_t const maxlen,
 940                                                         bool const shorten) const
 941 {
 942         if (!getLayout().isInToc())
 943                 return;
 944         text().forOutliner(os, maxlen, shorten);
 945 }
 946
 947
 948 void InsetText::addToToc(DocIterator const & cdit, bool output_active,
 949                                                  UpdateType utype, TocBackend & backend) const
 950 {
 951         DocIterator dit = cdit;
 952         dit.push_back(CursorSlice(const_cast<InsetText &>(*this)));
 953         iterateForToc(dit, output_active, utype, backend);
 954 }
 955
 956
 957 void InsetText::iterateForToc(DocIterator const & cdit, bool output_active,
 958                                                           UpdateType utype, TocBackend & backend) const
 959 {
 960         DocIterator dit = cdit;
 961         // This also ensures that any document has a table of contents
 962         shared_ptr<Toc> toc = backend.toc("tableofcontents");
 963
 964         BufferParams const & bufparams = buffer_->params();
 965         int const min_toclevel = bufparams.documentClass().min_toclevel();
 966         // we really should have done this before we got here, but it
 967         // can't hurt too much to do it again
 968         bool const doing_output = output_active && producesOutput();
 969
 970         // For each paragraph,
 971         // * Add a toc item for the paragraph if it is AddToToc--merging adjacent
 972         //   paragraphs as needed.
 973         // * Traverse its insets and let them add their toc items
 974         // * Compute the main table of contents (this is hardcoded)
 975         // * Add the list of changes
 976         ParagraphList const & pars = paragraphs();
 977         pit_type pend = paragraphs().size();
 978         // Record pairs {start,end} of where a toc item was opened for a paragraph
 979         // and where it must be closed
 980         stack<pair<pit_type, pit_type>> addtotoc_stack;
 981
 982         for (pit_type pit = 0; pit != pend; ++pit) {
 983                 Paragraph const & par = pars[pit];
 984                 dit.pit() = pit;
 985                 dit.pos() = 0;
 986
 987                 // Custom AddToToc in paragraph layouts (i.e. theorems)
 988                 if (par.layout().addToToc() && text().isFirstInSequence(pit)) {
 989                         pit_type end =
 990                                 openAddToTocForParagraph(pit, dit, output_active, backend);
 991                         addtotoc_stack.push({pit, end});
 992                 }
 993
 994                 // If we find an InsetArgument that is supposed to provide the TOC caption,
 995                 // we'll save it for use later.
 996                 InsetArgument const * arginset = nullptr;
 997                 for (auto const & table : par.insetList()) {
 998                         dit.pos() = table.pos;
 999                         table.inset->addToToc(dit, doing_output, utype, backend);
1000                         if (InsetArgument const * x = table.inset->asInsetArgument())
1001                                 if (x->isTocCaption())
1002                                         arginset = x;
1003                 }
1004
1005                 // End custom AddToToc in paragraph layouts
1006                 while (!addtotoc_stack.empty() && addtotoc_stack.top().second == pit) {
1007                         // execute the closing function
1008                         closeAddToTocForParagraph(addtotoc_stack.top().first,
1009                                                   addtotoc_stack.top().second, backend);
1010                         addtotoc_stack.pop();
1011                 }
1012
1013                 // now the toc entry for the paragraph in the main table of contents
1014                 int const toclevel = text().getTocLevel(pit);
1015                 if (toclevel != Layout::NOT_IN_TOC && toclevel >= min_toclevel) {
1016                         // insert this into the table of contents
1017                         docstring tocstring;
1018                         int const length = (doing_output && utype == OutputUpdate) ?
1019                                 INT_MAX : TOC_ENTRY_LENGTH;
1020                         if (arginset) {
1021                                 tocstring = par.labelString();
1022                                 if (!tocstring.empty())
1023                                         tocstring += ' ';
1024                                 arginset->text().forOutliner(tocstring, length);
1025                         } else
1026                                 par.forOutliner(tocstring, length);
1027                         dit.pos() = 0;
1028                         toc->push_back(TocItem(dit, toclevel - min_toclevel,
1029                                                tocstring, doing_output));
1030                 }
1031
1032                 // And now the list of changes.
1033                 par.addChangesToToc(dit, buffer(), doing_output, backend);
1034         }
1035 }
1036
1037
1038 pit_type InsetText::openAddToTocForParagraph(pit_type pit,
1039                                              DocIterator const & dit,
1040                                              bool output_active,
1041                                              TocBackend & backend) const
1042 {
1043         Paragraph const & par = paragraphs()[pit];
1044         TocBuilder & b = backend.builder(par.layout().tocType());
1045         docstring const & label = par.labelString();
1046         b.pushItem(dit, label + (label.empty() ? "" : " "), output_active);
1047         return text().lastInSequence(pit);
1048 }
1049
1050
1051 void InsetText::closeAddToTocForParagraph(pit_type start, pit_type end,
1052                                           TocBackend & backend) const
1053 {
1054         Paragraph const & par = paragraphs()[start];
1055         TocBuilder & b = backend.builder(par.layout().tocType());
1056         if (par.layout().isTocCaption()) {
1057                 docstring str;
1058                 text().forOutliner(str, TOC_ENTRY_LENGTH, start, end);
1059                 b.argumentItem(str);
1060         }
1061         b.pop();
1062 }
1063
1064
1065 bool InsetText::notifyCursorLeaves(Cursor const & old, Cursor & cur)
1066 {
1067         if (buffer().isClean())
1068                 return Inset::notifyCursorLeaves(old, cur);
1069
1070         // find text inset in old cursor
1071         Cursor insetCur = old;
1072         int scriptSlice = insetCur.find(this);
1073         // we can try to continue here. returning true means
1074         // the cursor is "now" invalid. which it was.
1075         LASSERT(scriptSlice != -1, return true);
1076         insetCur.cutOff(scriptSlice);
1077         LASSERT(&insetCur.inset() == this, return true);
1078
1079         // update the old paragraph's words
1080         insetCur.paragraph().updateWords();
1081
1082         return Inset::notifyCursorLeaves(old, cur);
1083 }
1084
1085
1086 bool InsetText::completionSupported(Cursor const & cur) const
1087 {
1088         //LASSERT(&cur.bv().cursor().inset() == this, return false);
1089         return text_.completionSupported(cur);
1090 }
1091
1092
1093 bool InsetText::inlineCompletionSupported(Cursor const & cur) const
1094 {
1095         return completionSupported(cur);
1096 }
1097
1098
1099 bool InsetText::automaticInlineCompletion() const
1100 {
1101         return lyxrc.completion_inline_text;
1102 }
1103
1104
1105 bool InsetText::automaticPopupCompletion() const
1106 {
1107         return lyxrc.completion_popup_text;
1108 }
1109
1110
1111 bool InsetText::showCompletionCursor() const
1112 {
1113         return lyxrc.completion_cursor_text;
1114 }
1115
1116
1117 CompletionList const * InsetText::createCompletionList(Cursor const & cur) const
1118 {
1119         return completionSupported(cur) ? text_.createCompletionList(cur) : 0;
1120 }
1121
1122
1123 docstring InsetText::completionPrefix(Cursor const & cur) const
1124 {
1125         if (!completionSupported(cur))
1126                 return docstring();
1127         return text_.completionPrefix(cur);
1128 }
1129
1130
1131 bool InsetText::insertCompletion(Cursor & cur, docstring const & s,
1132         bool finished)
1133 {
1134         if (!completionSupported(cur))
1135                 return false;
1136
1137         return text_.insertCompletion(cur, s, finished);
1138 }
1139
1140
1141 void InsetText::completionPosAndDim(Cursor const & cur, int & x, int & y,
1142         Dimension & dim) const
1143 {
1144         TextMetrics const & tm = cur.bv().textMetrics(&text_);
1145         tm.completionPosAndDim(cur, x, y, dim);
1146 }
1147
1148
1149 string InsetText::contextMenu(BufferView const &, int, int) const
1150 {
1151         string context_menu = contextMenuName();
1152         if (context_menu != InsetText::contextMenuName())
1153                 context_menu += ";" + InsetText::contextMenuName();
1154         return context_menu;
1155 }
1156
1157
1158 string InsetText::contextMenuName() const
1159 {
1160         return "context-edit";
1161 }
1162
1163
1164 docstring InsetText::toolTipText(docstring const & prefix, size_t const len) const
1165 {
1166         OutputParams rp(&buffer().params().encoding());
1167         rp.for_tooltip = true;
1168         odocstringstream oss;
1169         oss << prefix;
1170
1171         ParagraphList::const_iterator beg = paragraphs().begin();
1172         ParagraphList::const_iterator end = paragraphs().end();
1173         ParagraphList::const_iterator it = beg;
1174         bool ref_printed = false;
1175
1176         for (; it != end; ++it) {
1177                 if (it != beg)
1178                         oss << '\n';
1179                 if ((*it).isRTL(buffer().params()))
1180                         oss << "<div dir=\"rtl\">";
1181                 writePlaintextParagraph(buffer(), *it, oss, rp, ref_printed, len);
1182                 if (oss.tellp() >= 0 && size_t(oss.tellp()) > len)
1183                         break;
1184         }
1185         docstring str = oss.str();
1186         if (isChanged())
1187                 str += from_ascii("\n\n") + _("[contains tracked changes]");
1188         support::truncateWithEllipsis(str, len);
1189         return str;
1190 }
1191
1192
1193 InsetText::XHTMLOptions operator|(InsetText::XHTMLOptions a1, InsetText::XHTMLOptions a2)
1194 {
1195         return static_cast<InsetText::XHTMLOptions>((int)a1 | (int)a2);
1196 }
1197
1198
1199 bool InsetText::needsCProtection(bool const maintext, bool const fragile) const
1200 {
1201         // Nested cprotect content needs \cprotect
1202         // on each level
1203         if (producesOutput() && hasCProtectContent(fragile))
1204                 return true;
1205
1206         // Environments generally need cprotection in fragile context
1207         if (fragile && getLayout().latextype() == InsetLayout::ENVIRONMENT)
1208                 return true;
1209
1210         if (!getLayout().needsCProtect())
1211                 return false;
1212
1213         // Environments and "no latex" types (e.g., knitr chunks)
1214         // need cprotection regardless the content
1215         if (!maintext && getLayout().latextype() != InsetLayout::COMMAND)
1216                 return true;
1217
1218         // If the inset does not produce output (e.g. Note or Branch),
1219         // we can ignore the contained paragraphs
1220         if (!producesOutput())
1221                 return false;
1222
1223         // Commands need cprotection if they contain specific chars
1224         int const nchars_escape = 9;
1225         static char_type const chars_escape[nchars_escape] = {
1226                 '&', '_', '$', '%', '#', '^', '{', '}', '\\'};
1227
1228         ParagraphList const & pars = paragraphs();
1229         pit_type pend = pit_type(paragraphs().size());
1230
1231         for (pit_type pit = 0; pit != pend; ++pit) {
1232                 Paragraph const & par = pars[size_type(pit)];
1233                 if (par.needsCProtection(fragile))
1234                         return true;
1235                 docstring const par_str = par.asString();
1236                 for (int k = 0; k < nchars_escape; k++) {
1237                         if (contains(par_str, chars_escape[k]))
1238                                 return true;
1239                 }
1240         }
1241         return false;
1242 }
1243
1244 } // namespace lyx