src/insets/InsetText.cpp

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