src/insets/InsetText.cpp

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