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.forceOwnlines())
 437                 os << breakln;
 438         if (!il.latexname().empty()) {
 439                 if (il.latextype() == InsetLayout::COMMAND) {
 440                         // FIXME UNICODE
 441                         // FIXME \protect should only be used for fragile
 442                         //    commands, but we do not provide this information yet.
 443                         if (runparams.moving_arg)
 444                                 os << "\\protect";
 445                         os << '\\' << from_utf8(il.latexname());
 446                         if (!il.latexargs().empty())
 447                                 getArgs(os, runparams);
 448                         if (!il.latexparam().empty())
 449                                 os << from_utf8(il.latexparam());
 450                         os << '{';
 451                 } else if (il.latextype() == InsetLayout::ENVIRONMENT) {
 452                         if (il.isDisplay())
 453                                 os << breakln;
 454                         else
 455                                 os << safebreakln;
 456                         if (runparams.lastid != -1)
 457                                 os.texrow().start(runparams.lastid,
 458                                                   runparams.lastpos);
 459                         os << "\\begin{" << from_utf8(il.latexname()) << "}";
 460                         if (!il.latexargs().empty())
 461                                 getArgs(os, runparams);
 462                         if (!il.latexparam().empty())
 463                                 os << from_utf8(il.latexparam());
 464                         os << '\n';
 465                 }
 466         } else {
 467                 if (!il.latexargs().empty())
 468                         getArgs(os, runparams);
 469                 if (!il.latexparam().empty())
 470                         os << from_utf8(il.latexparam());
 471         }
 472
 473         if (!il.leftdelim().empty())
 474                 os << il.leftdelim();
 475
 476         OutputParams rp = runparams;
 477         if (isPassThru())
 478                 rp.pass_thru = true;
 479         if (il.isNeedProtect())
 480                 rp.moving_arg = true;
 481         if (!il.passThruChars().empty())
 482                 rp.pass_thru_chars += il.passThruChars();
 483         rp.par_begin = 0;
 484         rp.par_end = paragraphs().size();
 485
 486         // Output the contents of the inset
 487         latexParagraphs(buffer(), text_, os, rp);
 488         runparams.encoding = rp.encoding;
 489
 490         if (!il.rightdelim().empty())
 491                 os << il.rightdelim();
 492
 493         if (!il.latexname().empty()) {
 494                 if (il.latextype() == InsetLayout::COMMAND) {
 495                         os << "}";
 496                         if (!il.postcommandargs().empty())
 497                                 getArgs(os, runparams, true);
 498                 } else if (il.latextype() == InsetLayout::ENVIRONMENT) {
 499                         // A comment environment doesn't need a % before \n\end
 500                         if (il.isDisplay() || runparams.inComment)
 501                                 os << breakln;
 502                         else
 503                                 os << safebreakln;
 504                         os << "\\end{" << from_utf8(il.latexname()) << "}" << breakln;
 505                         if (!il.isDisplay())
 506                                 os.protectSpace(true);
 507                 }
 508         }
 509         if (il.forceOwnlines())
 510                 os << breakln;
 511 }
 512
 513
 514 int InsetText::plaintext(odocstringstream & os,
 515         OutputParams const & runparams, size_t max_length) const
 516 {
 517         ParagraphList::const_iterator beg = paragraphs().begin();
 518         ParagraphList::const_iterator end = paragraphs().end();
 519         ParagraphList::const_iterator it = beg;
 520         bool ref_printed = false;
 521         int len = 0;
 522         for (; it != end; ++it) {
 523                 if (it != beg) {
 524                         os << '\n';
 525                         if (runparams.linelen > 0)
 526                                 os << '\n';
 527                 }
 528                 odocstringstream oss;
 529                 writePlaintextParagraph(buffer(), *it, oss, runparams, ref_printed, max_length);
 530                 docstring const str = oss.str();
 531                 os << str;
 532                 // FIXME: len is not computed fully correctly; in principle,
 533                 // we have to count the characters after the last '\n'
 534                 len = str.size();
 535                 if (os.str().size() >= max_length)
 536                         break;
 537         }
 538
 539         return len;
 540 }
 541
 542
 543 int InsetText::docbook(odocstream & os, OutputParams const & runparams) const
 544 {
 545         ParagraphList::const_iterator const beg = paragraphs().begin();
 546
 547         if (!undefined())
 548                 sgml::openTag(os, getLayout().latexname(),
 549                               beg->getID(buffer(), runparams) + getLayout().latexparam());
 550
 551         docbookParagraphs(text_, buffer(), os, runparams);
 552
 553         if (!undefined())
 554                 sgml::closeTag(os, getLayout().latexname());
 555
 556         return 0;
 557 }
 558
 559
 560 docstring InsetText::xhtml(XHTMLStream & xs, OutputParams const & runparams) const
 561 {
 562         return insetAsXHTML(xs, runparams, WriteEverything);
 563 }
 564
 565
 566 // FIXME XHTML
 567 // There are cases where we may need to close open fonts and such
 568 // and then re-open them when we are done. This would be the case, e.g.,
 569 // if we were otherwise about to write:
 570 //              <em>word <div class='foot'>footnote text.</div> emph</em>
 571 // The problem isn't so much that the footnote text will get emphasized:
 572 // we can handle that with CSS. The problem is that this is invalid XHTML.
 573 // One solution would be to make the footnote <span>, but the problem is
 574 // completely general, and so we'd have to make absolutely everything into
 575 // span. What I think will work is to check if we're about to write "div" and,
 576 // if so, try to close fonts, etc.
 577 // There are probably limits to how well we can do here, though, and we will
 578 // have to rely upon users not putting footnotes inside noun-type insets.
 579 docstring InsetText::insetAsXHTML(XHTMLStream & xs, OutputParams const & rp,
 580                                   XHTMLOptions opts) const
 581 {
 582         // we will always want to output all our paragraphs when we are
 583         // called this way.
 584         OutputParams runparams = rp;
 585         runparams.par_begin = 0;
 586         runparams.par_end = text().paragraphs().size();
 587
 588         if (undefined()) {
 589                 xhtmlParagraphs(text_, buffer(), xs, runparams);
 590                 return docstring();
 591         }
 592
 593         InsetLayout const & il = getLayout();
 594         if (opts & WriteOuterTag)
 595                 xs << html::StartTag(il.htmltag(), il.htmlattr());
 596
 597         if ((opts & WriteLabel) && !il.counter().empty()) {
 598                 BufferParams const & bp = buffer().masterBuffer()->params();
 599                 Counters & cntrs = bp.documentClass().counters();
 600                 cntrs.step(il.counter(), OutputUpdate);
 601                 // FIXME: translate to paragraph language
 602                 if (!il.htmllabel().empty()) {
 603                         docstring const lbl =
 604                                 cntrs.counterLabel(from_utf8(il.htmllabel()), bp.language->code());
 605                         // FIXME is this check necessary?
 606                         if (!lbl.empty()) {
 607                                 xs << html::StartTag(il.htmllabeltag(), il.htmllabelattr());
 608                                 xs << lbl;
 609                                 xs << html::EndTag(il.htmllabeltag());
 610                         }
 611                 }
 612         }
 613
 614         if (opts & WriteInnerTag)
 615                 xs << html::StartTag(il.htmlinnertag(), il.htmlinnerattr());
 616
 617         // we will eventually lose information about the containing inset
 618         if (!allowMultiPar() || opts == JustText)
 619                 runparams.html_make_pars = false;
 620         if (il.isPassThru())
 621                 runparams.pass_thru = true;
 622
 623         xhtmlParagraphs(text_, buffer(), xs, runparams);
 624
 625         if (opts & WriteInnerTag)
 626                 xs << html::EndTag(il.htmlinnertag());
 627
 628         if (opts & WriteOuterTag)
 629                 xs << html::EndTag(il.htmltag());
 630
 631         return docstring();
 632 }
 633
 634 void InsetText::getArgs(otexstream & os, OutputParams const & runparams_in,
 635                         bool const post) const
 636 {
 637         OutputParams runparams = runparams_in;
 638         runparams.local_font =
 639                 &paragraphs()[0].getFirstFontSettings(buffer().masterBuffer()->params());
 640         if (isPassThru())
 641                 runparams.pass_thru = true;
 642         if (post)
 643                 latexArgInsets(paragraphs(), paragraphs().begin(), os, runparams, getLayout().postcommandargs(), "post:");
 644         else
 645                 latexArgInsets(paragraphs(), paragraphs().begin(), os, runparams, getLayout().latexargs());
 646 }
 647
 648
 649 void InsetText::cursorPos(BufferView const & bv,
 650                 CursorSlice const & sl, bool boundary, int & x, int & y) const
 651 {
 652         x = bv.textMetrics(&text_).cursorX(sl, boundary) + TEXT_TO_INSET_OFFSET;
 653         y = bv.textMetrics(&text_).cursorY(sl, boundary);
 654 }
 655
 656
 657 void InsetText::setText(docstring const & data, Font const & font, bool trackChanges)
 658 {
 659         clear();
 660         Paragraph & first = paragraphs().front();
 661         for (unsigned int i = 0; i < data.length(); ++i)
 662                 first.insertChar(i, data[i], font, trackChanges);
 663 }
 664
 665
 666 void InsetText::setDrawFrame(bool flag)
 667 {
 668         drawFrame_ = flag;
 669 }
 670
 671
 672 ColorCode InsetText::frameColor() const
 673 {
 674         return frame_color_;
 675 }
 676
 677
 678 void InsetText::setFrameColor(ColorCode col)
 679 {
 680         frame_color_ = col;
 681 }
 682
 683
 684 void InsetText::appendParagraphs(ParagraphList & plist)
 685 {
 686         // There is little we can do here to keep track of changes.
 687         // As of 2006/10/20, appendParagraphs is used exclusively by
 688         // LyXTabular::setMultiColumn. In this context, the paragraph break
 689         // is lost irreversibly and the appended text doesn't really change
 690
 691         ParagraphList & pl = paragraphs();
 692
 693         ParagraphList::iterator pit = plist.begin();
 694         ParagraphList::iterator ins = pl.insert(pl.end(), *pit);
 695         ++pit;
 696         mergeParagraph(buffer().params(), pl,
 697                        distance(pl.begin(), ins) - 1);
 698
 699         for_each(pit, plist.end(),
 700                  bind(&ParagraphList::push_back, ref(pl), _1));
 701 }
 702
 703
 704 void InsetText::addPreview(DocIterator const & text_inset_pos,
 705         PreviewLoader & loader) const
 706 {
 707         ParagraphList::const_iterator pit = paragraphs().begin();
 708         ParagraphList::const_iterator pend = paragraphs().end();
 709         int pidx = 0;
 710
 711         DocIterator inset_pos = text_inset_pos;
 712         inset_pos.push_back(CursorSlice(*const_cast<InsetText *>(this)));
 713
 714         for (; pit != pend; ++pit, ++pidx) {
 715                 InsetList::const_iterator it  = pit->insetList().begin();
 716                 InsetList::const_iterator end = pit->insetList().end();
 717                 inset_pos.pit() = pidx;
 718                 for (; it != end; ++it) {
 719                         inset_pos.pos() = it->pos;
 720                         it->inset->addPreview(inset_pos, loader);
 721                 }
 722         }
 723 }
 724
 725
 726 ParagraphList const & InsetText::paragraphs() const
 727 {
 728         return text_.paragraphs();
 729 }
 730
 731
 732 ParagraphList & InsetText::paragraphs()
 733 {
 734         return text_.paragraphs();
 735 }
 736
 737
 738 bool InsetText::insetAllowed(InsetCode code) const
 739 {
 740         switch (code) {
 741         // Arguments are also allowed in PassThru insets
 742         case ARG_CODE:
 743                 return true;
 744         default:
 745                 return !isPassThru();
 746         }
 747 }
 748
 749
 750 void InsetText::updateBuffer(ParIterator const & it, UpdateType utype)
 751 {
 752         ParIterator it2 = it;
 753         it2.forwardPos();
 754         LASSERT(&it2.inset() == this && it2.pit() == 0, return);
 755         if (producesOutput()) {
 756                 InsetLayout const & il = getLayout();
 757                 bool const save_layouts = utype == OutputUpdate && il.htmlisblock();
 758                 Counters & cnt = buffer().masterBuffer()->params().documentClass().counters();
 759                 if (save_layouts) {
 760                         // LYXERR0("Entering " << name());
 761                         cnt.clearLastLayout();
 762                         // FIXME cnt.saveLastCounter()?
 763                 }
 764                 buffer().updateBuffer(it2, utype);
 765                 if (save_layouts) {
 766                         // LYXERR0("Exiting " << name());
 767                         cnt.restoreLastLayout();
 768                         // FIXME cnt.restoreLastCounter()?
 769                 }
 770         } else {
 771                 DocumentClass const & tclass = buffer().masterBuffer()->params().documentClass();
 772                 // Note that we do not need to call:
 773                 //      tclass.counters().clearLastLayout()
 774                 // since we are saving and restoring the existing counters, etc.
 775                 Counters const savecnt = tclass.counters();
 776                 tclass.counters().reset();
 777                 // we need float information even in note insets (#9760)
 778                 tclass.counters().current_float(savecnt.current_float());
 779                 tclass.counters().isSubfloat(savecnt.isSubfloat());
 780                 buffer().updateBuffer(it2, utype);
 781                 tclass.counters() = savecnt;
 782         }
 783 }
 784
 785
 786 void InsetText::toString(odocstream & os) const
 787 {
 788         os << text().asString(0, 1, AS_STR_LABEL | AS_STR_INSETS);
 789 }
 790
 791
 792 void InsetText::forOutliner(docstring & os, size_t maxlen) const
 793 {
 794         if (!getLayout().isInToc())
 795                 return;
 796         text().forOutliner(os, maxlen, false);
 797 }
 798
 799
 800 void InsetText::addToToc(DocIterator const & cdit, bool output_active,
 801                                                  UpdateType utype) const
 802 {
 803         DocIterator dit = cdit;
 804         dit.push_back(CursorSlice(const_cast<InsetText &>(*this)));
 805         iterateForToc(dit, output_active, utype);
 806 }
 807
 808
 809 void InsetText::iterateForToc(DocIterator const & cdit, bool output_active,
 810                                                           UpdateType utype) const
 811 {
 812         DocIterator dit = cdit;
 813         // This also ensures that any document has a table of contents
 814         shared_ptr<Toc> toc = buffer().tocBackend().toc("tableofcontents");
 815
 816         BufferParams const & bufparams = buffer_->params();
 817         int const min_toclevel = bufparams.documentClass().min_toclevel();
 818         // we really should have done this before we got here, but it
 819         // can't hurt too much to do it again
 820         bool const doing_output = output_active && producesOutput();
 821
 822         // For each paragraph, traverse its insets and let them add
 823         // their toc items
 824         ParagraphList const & pars = paragraphs();
 825         pit_type pend = paragraphs().size();
 826         for (pit_type pit = 0; pit != pend; ++pit) {
 827                 Paragraph const & par = pars[pit];
 828                 dit.pit() = pit;
 829                 // if we find an optarg, we'll save it for use later.
 830                 InsetText const * arginset = 0;
 831                 InsetList::const_iterator it  = par.insetList().begin();
 832                 InsetList::const_iterator end = par.insetList().end();
 833                 for (; it != end; ++it) {
 834                         Inset & inset = *it->inset;
 835                         dit.pos() = it->pos;
 836                         //lyxerr << (void*)&inset << " code: " << inset.lyxCode() << std::endl;
 837                         inset.addToToc(dit, doing_output, utype);
 838                         if (inset.lyxCode() == ARG_CODE)
 839                                 arginset = inset.asInsetText();
 840                 }
 841                 // now the toc entry for the paragraph
 842                 int const toclevel = text().getTocLevel(pit);
 843                 if (toclevel != Layout::NOT_IN_TOC && toclevel >= min_toclevel) {
 844                         // insert this into the table of contents
 845                         docstring tocstring;
 846                         int const length = (doing_output && utype == OutputUpdate) ?
 847                                 INT_MAX : TOC_ENTRY_LENGTH;
 848                         if (arginset) {
 849                                 tocstring = par.labelString();
 850                                 if (!tocstring.empty())
 851                                         tocstring += ' ';
 852                                 arginset->text().forOutliner(tocstring, length);
 853                         } else
 854                                 par.forOutliner(tocstring, length);
 855                         dit.pos() = 0;
 856                         toc->push_back(TocItem(dit, toclevel - min_toclevel,
 857                                                                   tocstring, doing_output, tocstring));
 858                 }
 859
 860                 // And now the list of changes.
 861                 par.addChangesToToc(dit, buffer(), doing_output);
 862         }
 863 }
 864
 865
 866 bool InsetText::notifyCursorLeaves(Cursor const & old, Cursor & cur)
 867 {
 868         if (buffer().isClean())
 869                 return Inset::notifyCursorLeaves(old, cur);
 870
 871         // find text inset in old cursor
 872         Cursor insetCur = old;
 873         int scriptSlice = insetCur.find(this);
 874         // we can try to continue here. returning true means
 875         // the cursor is "now" invalid. which it was.
 876         LASSERT(scriptSlice != -1, return true);
 877         insetCur.cutOff(scriptSlice);
 878         LASSERT(&insetCur.inset() == this, return true);
 879
 880         // update the old paragraph's words
 881         insetCur.paragraph().updateWords();
 882
 883         return Inset::notifyCursorLeaves(old, cur);
 884 }
 885
 886
 887 bool InsetText::completionSupported(Cursor const & cur) const
 888 {
 889         //LASSERT(&cur.bv().cursor().inset() == this, return false);
 890         return text_.completionSupported(cur);
 891 }
 892
 893
 894 bool InsetText::inlineCompletionSupported(Cursor const & cur) const
 895 {
 896         return completionSupported(cur);
 897 }
 898
 899
 900 bool InsetText::automaticInlineCompletion() const
 901 {
 902         return lyxrc.completion_inline_text;
 903 }
 904
 905
 906 bool InsetText::automaticPopupCompletion() const
 907 {
 908         return lyxrc.completion_popup_text;
 909 }
 910
 911
 912 bool InsetText::showCompletionCursor() const
 913 {
 914         return lyxrc.completion_cursor_text;
 915 }
 916
 917
 918 CompletionList const * InsetText::createCompletionList(Cursor const & cur) const
 919 {
 920         return completionSupported(cur) ? text_.createCompletionList(cur) : 0;
 921 }
 922
 923
 924 docstring InsetText::completionPrefix(Cursor const & cur) const
 925 {
 926         if (!completionSupported(cur))
 927                 return docstring();
 928         return text_.completionPrefix(cur);
 929 }
 930
 931
 932 bool InsetText::insertCompletion(Cursor & cur, docstring const & s,
 933         bool finished)
 934 {
 935         if (!completionSupported(cur))
 936                 return false;
 937
 938         return text_.insertCompletion(cur, s, finished);
 939 }
 940
 941
 942 void InsetText::completionPosAndDim(Cursor const & cur, int & x, int & y,
 943         Dimension & dim) const
 944 {
 945         TextMetrics const & tm = cur.bv().textMetrics(&text_);
 946         tm.completionPosAndDim(cur, x, y, dim);
 947 }
 948
 949
 950 string InsetText::contextMenu(BufferView const &, int, int) const
 951 {
 952         string context_menu = contextMenuName();
 953         if (context_menu != InsetText::contextMenuName())
 954                 context_menu += ";" + InsetText::contextMenuName();
 955         return context_menu;
 956 }
 957
 958
 959 string InsetText::contextMenuName() const
 960 {
 961         return "context-edit";
 962 }
 963
 964
 965 docstring InsetText::toolTipText(docstring prefix,
 966                 size_t numlines, size_t len) const
 967 {
 968         size_t const max_length = numlines * len;
 969         OutputParams rp(&buffer().params().encoding());
 970         rp.for_tooltip = true;
 971         odocstringstream oss;
 972         oss << prefix;
 973
 974         ParagraphList::const_iterator beg = paragraphs().begin();
 975         ParagraphList::const_iterator end = paragraphs().end();
 976         ParagraphList::const_iterator it = beg;
 977         bool ref_printed = false;
 978         docstring str;
 979
 980         for (; it != end; ++it) {
 981                 if (it != beg)
 982                         oss << '\n';
 983                 writePlaintextParagraph(buffer(), *it, oss, rp, ref_printed, max_length);
 984                 str = oss.str();
 985                 if (str.length() >= max_length)
 986                         break;
 987         }
 988         return support::wrapParas(str, 4, len, numlines);
 989 }
 990
 991
 992 InsetCaption const * InsetText::getCaptionInset() const
 993 {
 994         ParagraphList::const_iterator pit = paragraphs().begin();
 995         for (; pit != paragraphs().end(); ++pit) {
 996                 InsetList::const_iterator it = pit->insetList().begin();
 997                 for (; it != pit->insetList().end(); ++it) {
 998                         Inset & inset = *it->inset;
 999                         if (inset.lyxCode() == CAPTION_CODE) {
1000                                 InsetCaption const * ins =
1001                                         static_cast<InsetCaption const *>(it->inset);
1002                                 return ins;
1003                         }
1004                 }
1005         }
1006         return 0;
1007 }
1008
1009
1010 docstring InsetText::getCaptionText(OutputParams const & runparams) const
1011 {
1012         InsetCaption const * ins = getCaptionInset();
1013         if (ins == 0)
1014                 return docstring();
1015
1016         odocstringstream ods;
1017         ins->getCaptionAsPlaintext(ods, runparams);
1018         return ods.str();
1019 }
1020
1021
1022 docstring InsetText::getCaptionHTML(OutputParams const & runparams) const
1023 {
1024         InsetCaption const * ins = getCaptionInset();
1025         if (ins == 0)
1026                 return docstring();
1027
1028         odocstringstream ods;
1029         XHTMLStream xs(ods);
1030         docstring def = ins->getCaptionAsHTML(xs, runparams);
1031         if (!def.empty())
1032                 // should already have been escaped
1033                 xs << XHTMLStream::ESCAPE_NONE << def << '\n';
1034         return ods.str();
1035 }
1036
1037
1038 InsetText::XHTMLOptions operator|(InsetText::XHTMLOptions a1, InsetText::XHTMLOptions a2)
1039 {
1040         return static_cast<InsetText::XHTMLOptions>((int)a1 | (int)a2);
1041 }
1042
1043 } // namespace lyx