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 0
 270 // FIXME: This code does not seem to be necessary anymore
 271 // Remove for 2.1 if no counter-evidence is found.
 272         if (isPassThru() && lyxCode() != ARG_CODE) {
 273                 // Force any new text to latex_language FIXME: This
 274                 // should only be necessary in constructor, but new
 275                 // paragraphs that are created by pressing enter at
 276                 // the start of an existing paragraph get the buffer
 277                 // language and not latex_language, so we take this
 278                 // brute force approach.
 279                 cur.current_font.setLanguage(latex_language);
 280                 cur.real_current_font.setLanguage(latex_language);
 281         }
 282 #endif
 283
 284         switch (cmd.action()) {
 285         case LFUN_PASTE:
 286         case LFUN_CLIPBOARD_PASTE:
 287         case LFUN_SELECTION_PASTE:
 288         case LFUN_PRIMARY_SELECTION_PASTE:
 289                 text_.dispatch(cur, cmd);
 290                 // If we we can only store plain text, we must reset all
 291                 // attributes.
 292                 // FIXME: Change only the pasted paragraphs
 293                 fixParagraphsFont();
 294                 break;
 295
 296         case LFUN_INSET_DISSOLVE: {
 297                 bool const main_inset = &buffer().inset() == this;
 298                 bool const target_inset = cmd.argument().empty()
 299                         || cmd.getArg(0) == insetName(lyxCode());
 300                 bool const one_cell = nargs() == 1;
 301
 302                 if (!main_inset && target_inset && one_cell) {
 303                         // Text::dissolveInset assumes that the cursor
 304                         // is inside the Inset.
 305                         if (&cur.inset() != this)
 306                                 cur.pushBackward(*this);
 307                         cur.beginUndoGroup();
 308                         text_.dispatch(cur, cmd);
 309                         cur.endUndoGroup();
 310                 } else
 311                         cur.undispatched();
 312                 break;
 313         }
 314
 315         default:
 316                 text_.dispatch(cur, cmd);
 317         }
 318
 319         if (!cur.result().dispatched())
 320                 Inset::doDispatch(cur, cmd);
 321 }
 322
 323
 324 bool InsetText::getStatus(Cursor & cur, FuncRequest const & cmd,
 325         FuncStatus & status) const
 326 {
 327         switch (cmd.action()) {
 328         case LFUN_INSET_DISSOLVE: {
 329                 bool const main_inset = &buffer().inset() == this;
 330                 bool const target_inset = cmd.argument().empty()
 331                         || cmd.getArg(0) == insetName(lyxCode());
 332                 bool const one_cell = nargs() == 1;
 333
 334                 if (target_inset)
 335                         status.setEnabled(!main_inset && one_cell);
 336                 return target_inset;
 337         }
 338
 339         case LFUN_ARGUMENT_INSERT: {
 340                 string const arg = cmd.getArg(0);
 341                 if (arg.empty()) {
 342                         status.setEnabled(false);
 343                         return true;
 344                 }
 345                 if (&buffer().inset() == this || !cur.paragraph().layout().args().empty())
 346                         return text_.getStatus(cur, cmd, status);
 347
 348                 Layout::LaTeXArgMap args = getLayout().latexargs();
 349                 Layout::LaTeXArgMap::const_iterator const lait = args.find(arg);
 350                 if (lait != args.end()) {
 351                         status.setEnabled(true);
 352                         ParagraphList::const_iterator pit = paragraphs().begin();
 353                         for (; pit != paragraphs().end(); ++pit) {
 354                                 InsetList::const_iterator it = pit->insetList().begin();
 355                                 InsetList::const_iterator end = pit->insetList().end();
 356                                 for (; it != end; ++it) {
 357                                         if (it->inset->lyxCode() == ARG_CODE) {
 358                                                 InsetArgument const * ins =
 359                                                         static_cast<InsetArgument const *>(it->inset);
 360                                                 if (ins->name() == arg) {
 361                                                         // we have this already
 362                                                         status.setEnabled(false);
 363                                                         return true;
 364                                                 }
 365                                         }
 366                                 }
 367                         }
 368                 } else
 369                         status.setEnabled(false);
 370                 return true;
 371         }
 372
 373         default:
 374                 // Dispatch only to text_ if the cursor is inside
 375                 // the text_. It is not for context menus (bug 5797).
 376                 bool ret = false;
 377                 if (cur.text() == &text_)
 378                         ret = text_.getStatus(cur, cmd, status);
 379
 380                 if (!ret)
 381                         ret = Inset::getStatus(cur, cmd, status);
 382                 return ret;
 383         }
 384 }
 385
 386
 387 void InsetText::fixParagraphsFont()
 388 {
 389         Font font(inherit_font, buffer().params().language);
 390         font.setLanguage(latex_language);
 391         ParagraphList::iterator par = paragraphs().begin();
 392         ParagraphList::iterator const end = paragraphs().end();
 393         while (par != end) {
 394                 if (par->isPassThru())
 395                         par->resetFonts(font);
 396                 if (!par->allowParagraphCustomization())
 397                         par->params().clear();
 398                 ++par;
 399         }
 400 }
 401
 402
 403 void InsetText::setChange(Change const & change)
 404 {
 405         ParagraphList::iterator pit = paragraphs().begin();
 406         ParagraphList::iterator end = paragraphs().end();
 407         for (; pit != end; ++pit) {
 408                 pit->setChange(change);
 409         }
 410 }
 411
 412
 413 void InsetText::acceptChanges()
 414 {
 415         text_.acceptChanges();
 416 }
 417
 418
 419 void InsetText::rejectChanges()
 420 {
 421         text_.rejectChanges();
 422 }
 423
 424
 425 void InsetText::validate(LaTeXFeatures & features) const
 426 {
 427         features.useInsetLayout(getLayout());
 428         for_each(paragraphs().begin(), paragraphs().end(),
 429                  bind(&Paragraph::validate, _1, ref(features)));
 430 }
 431
 432
 433 void InsetText::latex(otexstream & os, OutputParams const & runparams) const
 434 {
 435         // This implements the standard way of handling the LaTeX
 436         // output of a text inset, either a command or an
 437         // environment. Standard collapsable insets should not
 438         // redefine this, non-standard ones may call this.
 439         InsetLayout const & il = getLayout();
 440         if (!il.latexname().empty()) {
 441                 if (il.latextype() == InsetLayout::COMMAND) {
 442                         // FIXME UNICODE
 443                         if (runparams.moving_arg)
 444                                 os << "\\protect";
 445                         os << '\\' << from_utf8(il.latexname());
 446                         if (!il.latexargs().empty())
 447                                 getOptArg(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                                 getOptArg(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                         getOptArg(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         rp.par_begin = 0;
 482         rp.par_end = paragraphs().size();
 483
 484         // Output the contents of the inset
 485         latexParagraphs(buffer(), text_, os, rp);
 486         runparams.encoding = rp.encoding;
 487
 488         if (!il.rightdelim().empty())
 489                 os << il.rightdelim();
 490
 491         if (!il.latexname().empty()) {
 492                 if (il.latextype() == InsetLayout::COMMAND) {
 493                         os << "}";
 494                 } else if (il.latextype() == InsetLayout::ENVIRONMENT) {
 495                         // A comment environment doesn't need a % before \n\end
 496                         if (il.isDisplay() || runparams.inComment)
 497                             os << breakln;
 498                         else
 499                             os << safebreakln;
 500                         os << "\\end{" << from_utf8(il.latexname()) << "}\n";
 501                         if (!il.isDisplay())
 502                                 os.protectSpace(true);
 503                 }
 504         }
 505 }
 506
 507
 508 int InsetText::plaintext(odocstream & os, OutputParams const & runparams) const
 509 {
 510         ParagraphList::const_iterator beg = paragraphs().begin();
 511         ParagraphList::const_iterator end = paragraphs().end();
 512         ParagraphList::const_iterator it = beg;
 513         bool ref_printed = false;
 514         int len = 0;
 515         for (; it != end; ++it) {
 516                 if (it != beg) {
 517                         os << '\n';
 518                         if (runparams.linelen > 0)
 519                                 os << '\n';
 520                 }
 521                 odocstringstream oss;
 522                 writePlaintextParagraph(buffer(), *it, oss, runparams, ref_printed);
 523                 docstring const str = oss.str();
 524                 os << str;
 525                 // FIXME: len is not computed fully correctly; in principle,
 526                 // we have to count the characters after the last '\n'
 527                 len = str.size();
 528         }
 529
 530         return len;
 531 }
 532
 533
 534 int InsetText::docbook(odocstream & os, OutputParams const & runparams) const
 535 {
 536         ParagraphList::const_iterator const beg = paragraphs().begin();
 537
 538         if (!undefined())
 539                 sgml::openTag(os, getLayout().latexname(),
 540                               beg->getID(buffer(), runparams) + getLayout().latexparam());
 541
 542         docbookParagraphs(text_, buffer(), os, runparams);
 543
 544         if (!undefined())
 545                 sgml::closeTag(os, getLayout().latexname());
 546
 547         return 0;
 548 }
 549
 550
 551 docstring InsetText::xhtml(XHTMLStream & xs, OutputParams const & runparams) const
 552 {
 553         return insetAsXHTML(xs, runparams, WriteEverything);
 554 }
 555
 556
 557 // FIXME XHTML
 558 // There are cases where we may need to close open fonts and such
 559 // and then re-open them when we are done. This would be the case, e.g.,
 560 // if we were otherwise about to write:
 561 //              <em>word <div class='foot'>footnote text.</div> emph</em>
 562 // The problem isn't so much that the footnote text will get emphasized:
 563 // we can handle that with CSS. The problem is that this is invalid XHTML.
 564 // One solution would be to make the footnote <span>, but the problem is
 565 // completely general, and so we'd have to make absolutely everything into
 566 // span. What I think will work is to check if we're about to write "div" and,
 567 // if so, try to close fonts, etc.
 568 // There are probably limits to how well we can do here, though, and we will
 569 // have to rely upon users not putting footnotes inside noun-type insets.
 570 docstring InsetText::insetAsXHTML(XHTMLStream & xs, OutputParams const & rp,
 571                                   XHTMLOptions opts) const
 572 {
 573         // we will always want to output all our paragraphs when we are
 574         // called this way.
 575         OutputParams runparams = rp;
 576         runparams.par_begin = 0;
 577         runparams.par_end = text().paragraphs().size();
 578
 579         if (undefined()) {
 580                 xhtmlParagraphs(text_, buffer(), xs, runparams);
 581                 return docstring();
 582         }
 583
 584         InsetLayout const & il = getLayout();
 585         if (opts & WriteOuterTag)
 586                 xs << html::StartTag(il.htmltag(), il.htmlattr());
 587
 588         if ((opts & WriteLabel) && !il.counter().empty()) {
 589                 BufferParams const & bp = buffer().masterBuffer()->params();
 590                 Counters & cntrs = bp.documentClass().counters();
 591                 cntrs.step(il.counter(), OutputUpdate);
 592                 // FIXME: translate to paragraph language
 593                 if (!il.htmllabel().empty()) {
 594                         docstring const lbl =
 595                                 cntrs.counterLabel(from_utf8(il.htmllabel()), bp.language->code());
 596                         // FIXME is this check necessary?
 597                         if (!lbl.empty()) {
 598                                 xs << html::StartTag(il.htmllabeltag(), il.htmllabelattr());
 599                                 xs << lbl;
 600                                 xs << html::EndTag(il.htmllabeltag());
 601                         }
 602                 }
 603         }
 604
 605         if (opts & WriteInnerTag)
 606                 xs << html::StartTag(il.htmlinnertag(), il.htmlinnerattr());
 607
 608         // we will eventually lose information about the containing inset
 609         if (!il.isMultiPar() || opts == JustText)
 610                 runparams.html_make_pars = false;
 611         if (il.isPassThru())
 612                 runparams.pass_thru = true;
 613
 614         xhtmlParagraphs(text_, buffer(), xs, runparams);
 615
 616         if (opts & WriteInnerTag)
 617                 xs << html::EndTag(il.htmlinnertag());
 618
 619         if (opts & WriteOuterTag)
 620                 xs << html::EndTag(il.htmltag());
 621
 622         return docstring();
 623 }
 624
 625 void InsetText::getOptArg(otexstream & os,
 626                         OutputParams const & runparams_in) const
 627 {
 628         OutputParams runparams = runparams_in;
 629         runparams.local_font =
 630                 &paragraphs()[0].getFirstFontSettings(buffer().masterBuffer()->params());
 631         if (isPassThru())
 632                 runparams.pass_thru = true;
 633         latexArgInsets(paragraphs(), paragraphs().begin(), os, runparams, getLayout().latexargs());
 634 }
 635
 636
 637 void InsetText::cursorPos(BufferView const & bv,
 638                 CursorSlice const & sl, bool boundary, int & x, int & y) const
 639 {
 640         x = bv.textMetrics(&text_).cursorX(sl, boundary) + TEXT_TO_INSET_OFFSET;
 641         y = bv.textMetrics(&text_).cursorY(sl, boundary);
 642 }
 643
 644
 645 void InsetText::setText(docstring const & data, Font const & font, bool trackChanges)
 646 {
 647         clear();
 648         Paragraph & first = paragraphs().front();
 649         for (unsigned int i = 0; i < data.length(); ++i)
 650                 first.insertChar(i, data[i], font, trackChanges);
 651 }
 652
 653
 654 void InsetText::setAutoBreakRows(bool flag)
 655 {
 656         if (flag == text_.autoBreakRows_)
 657                 return;
 658
 659         text_.autoBreakRows_ = flag;
 660         if (flag)
 661                 return;
 662
 663         // remove previously existing newlines
 664         ParagraphList::iterator it = paragraphs().begin();
 665         ParagraphList::iterator end = paragraphs().end();
 666         for (; it != end; ++it)
 667                 for (int i = 0; i < it->size(); ++i)
 668                         if (it->isNewline(i))
 669                                 // do not track the change, because the user
 670                                 // is not allowed to revert/reject it
 671                                 it->eraseChar(i, false);
 672 }
 673
 674
 675 void InsetText::setDrawFrame(bool flag)
 676 {
 677         drawFrame_ = flag;
 678 }
 679
 680
 681 ColorCode InsetText::frameColor() const
 682 {
 683         return frame_color_;
 684 }
 685
 686
 687 void InsetText::setFrameColor(ColorCode col)
 688 {
 689         frame_color_ = col;
 690 }
 691
 692
 693 void InsetText::appendParagraphs(ParagraphList & plist)
 694 {
 695         // There is little we can do here to keep track of changes.
 696         // As of 2006/10/20, appendParagraphs is used exclusively by
 697         // LyXTabular::setMultiColumn. In this context, the paragraph break
 698         // is lost irreversibly and the appended text doesn't really change
 699
 700         ParagraphList & pl = paragraphs();
 701
 702         ParagraphList::iterator pit = plist.begin();
 703         ParagraphList::iterator ins = pl.insert(pl.end(), *pit);
 704         ++pit;
 705         mergeParagraph(buffer().params(), pl,
 706                        distance(pl.begin(), ins) - 1);
 707
 708         for_each(pit, plist.end(),
 709                  bind(&ParagraphList::push_back, ref(pl), _1));
 710 }
 711
 712
 713 void InsetText::addPreview(DocIterator const & text_inset_pos,
 714         PreviewLoader & loader) const
 715 {
 716         ParagraphList::const_iterator pit = paragraphs().begin();
 717         ParagraphList::const_iterator pend = paragraphs().end();
 718         int pidx = 0;
 719
 720         DocIterator inset_pos = text_inset_pos;
 721         inset_pos.push_back(CursorSlice(*const_cast<InsetText *>(this)));
 722
 723         for (; pit != pend; ++pit, ++pidx) {
 724                 InsetList::const_iterator it  = pit->insetList().begin();
 725                 InsetList::const_iterator end = pit->insetList().end();
 726                 inset_pos.pit() = pidx;
 727                 for (; it != end; ++it) {
 728                         inset_pos.pos() = it->pos;
 729                         it->inset->addPreview(inset_pos, loader);
 730                 }
 731         }
 732 }
 733
 734
 735 ParagraphList const & InsetText::paragraphs() const
 736 {
 737         return text_.paragraphs();
 738 }
 739
 740
 741 ParagraphList & InsetText::paragraphs()
 742 {
 743         return text_.paragraphs();
 744 }
 745
 746
 747 bool InsetText::insetAllowed(InsetCode code) const
 748 {
 749         switch (code) {
 750         // Arguments are also allowed in PassThru insets
 751         case ARG_CODE:
 752                 return true;
 753         default:
 754                 return !isPassThru();
 755         }
 756 }
 757
 758
 759 void InsetText::updateBuffer(ParIterator const & it, UpdateType utype)
 760 {
 761         ParIterator it2 = it;
 762         it2.forwardPos();
 763         LASSERT(&it2.inset() == this && it2.pit() == 0, return);
 764         if (producesOutput()) {
 765                 InsetLayout const & il = getLayout();
 766                 bool const save_layouts = utype == OutputUpdate && il.htmlisblock();
 767                 Counters & cnt = buffer().masterBuffer()->params().documentClass().counters();
 768                 if (save_layouts) {
 769                         // LYXERR0("Entering " << name());
 770                         cnt.clearLastLayout();
 771                         // FIXME cnt.saveLastCounter()?
 772                 }
 773                 buffer().updateBuffer(it2, utype);
 774                 if (save_layouts) {
 775                         // LYXERR0("Exiting " << name());
 776                         cnt.restoreLastLayout();
 777                         // FIXME cnt.restoreLastCounter()?
 778                 }
 779         } else {
 780                 DocumentClass const & tclass = buffer().masterBuffer()->params().documentClass();
 781                 // Note that we do not need to call:
 782                 //      tclass.counters().clearLastLayout()
 783                 // since we are saving and restoring the existing counters, etc.
 784                 Counters const savecnt = tclass.counters();
 785                 tclass.counters().reset();
 786                 buffer().updateBuffer(it2, utype);
 787                 tclass.counters() = savecnt;
 788         }
 789 }
 790
 791
 792 void InsetText::toString(odocstream & os) const
 793 {
 794         os << text().asString(0, 1, AS_STR_LABEL | AS_STR_INSETS);
 795 }
 796
 797
 798 void InsetText::forToc(docstring & os, size_t maxlen) const
 799 {
 800         if (!getLayout().isInToc())
 801                 return;
 802         text().forToc(os, maxlen, false);
 803 }
 804
 805
 806 void InsetText::addToToc(DocIterator const & cdit) const
 807 {
 808         DocIterator dit = cdit;
 809         dit.push_back(CursorSlice(const_cast<InsetText &>(*this)));
 810         Toc & toc = buffer().tocBackend().toc("tableofcontents");
 811
 812         BufferParams const & bufparams = buffer_->params();
 813         int const min_toclevel = bufparams.documentClass().min_toclevel();
 814
 815         // For each paragraph, traverse its insets and let them add
 816         // their toc items
 817         ParagraphList const & pars = paragraphs();
 818         pit_type pend = paragraphs().size();
 819         for (pit_type pit = 0; pit != pend; ++pit) {
 820                 Paragraph const & par = pars[pit];
 821                 dit.pit() = pit;
 822                 // if we find an optarg, we'll save it for use later.
 823                 InsetText const * arginset = 0;
 824                 InsetList::const_iterator it  = par.insetList().begin();
 825                 InsetList::const_iterator end = par.insetList().end();
 826                 for (; it != end; ++it) {
 827                         Inset & inset = *it->inset;
 828                         dit.pos() = it->pos;
 829                         //lyxerr << (void*)&inset << " code: " << inset.lyxCode() << std::endl;
 830                         inset.addToToc(dit);
 831                         if (inset.lyxCode() == ARG_CODE)
 832                                 arginset = inset.asInsetText();
 833                 }
 834                 // now the toc entry for the paragraph
 835                 int const toclevel = text().getTocLevel(pit);
 836                 if (toclevel != Layout::NOT_IN_TOC && toclevel >= min_toclevel) {
 837                         // insert this into the table of contents
 838                         docstring tocstring;
 839                         if (arginset) {
 840                                 tocstring = par.labelString();
 841                                 if (!tocstring.empty())
 842                                         tocstring += ' ';
 843                                 arginset->text().forToc(tocstring, TOC_ENTRY_LENGTH);
 844                         } else
 845                                 par.forToc(tocstring, TOC_ENTRY_LENGTH);
 846                         dit.pos() = 0;
 847                         toc.push_back(TocItem(dit, toclevel - min_toclevel,
 848                                 tocstring, tocstring));
 849                 }
 850
 851                 // And now the list of changes.
 852                 par.addChangesToToc(dit, buffer());
 853         }
 854 }
 855
 856
 857 bool InsetText::notifyCursorLeaves(Cursor const & old, Cursor & cur)
 858 {
 859         if (buffer().isClean())
 860                 return Inset::notifyCursorLeaves(old, cur);
 861
 862         // find text inset in old cursor
 863         Cursor insetCur = old;
 864         int scriptSlice = insetCur.find(this);
 865         LASSERT(scriptSlice != -1, /**/);
 866         insetCur.cutOff(scriptSlice);
 867         LASSERT(&insetCur.inset() == this, /**/);
 868
 869         // update the old paragraph's words
 870         insetCur.paragraph().updateWords();
 871
 872         return Inset::notifyCursorLeaves(old, cur);
 873 }
 874
 875
 876 bool InsetText::completionSupported(Cursor const & cur) const
 877 {
 878         //LASSERT(&cur.bv().cursor().inset() != this, return false);
 879         return text_.completionSupported(cur);
 880 }
 881
 882
 883 bool InsetText::inlineCompletionSupported(Cursor const & cur) const
 884 {
 885         return completionSupported(cur);
 886 }
 887
 888
 889 bool InsetText::automaticInlineCompletion() const
 890 {
 891         return lyxrc.completion_inline_text;
 892 }
 893
 894
 895 bool InsetText::automaticPopupCompletion() const
 896 {
 897         return lyxrc.completion_popup_text;
 898 }
 899
 900
 901 bool InsetText::showCompletionCursor() const
 902 {
 903         return lyxrc.completion_cursor_text;
 904 }
 905
 906
 907 CompletionList const * InsetText::createCompletionList(Cursor const & cur) const
 908 {
 909         return completionSupported(cur) ? text_.createCompletionList(cur) : 0;
 910 }
 911
 912
 913 docstring InsetText::completionPrefix(Cursor const & cur) const
 914 {
 915         if (!completionSupported(cur))
 916                 return docstring();
 917         return text_.completionPrefix(cur);
 918 }
 919
 920
 921 bool InsetText::insertCompletion(Cursor & cur, docstring const & s,
 922         bool finished)
 923 {
 924         if (!completionSupported(cur))
 925                 return false;
 926
 927         return text_.insertCompletion(cur, s, finished);
 928 }
 929
 930
 931 void InsetText::completionPosAndDim(Cursor const & cur, int & x, int & y,
 932         Dimension & dim) const
 933 {
 934         TextMetrics const & tm = cur.bv().textMetrics(&text_);
 935         tm.completionPosAndDim(cur, x, y, dim);
 936 }
 937
 938
 939 string InsetText::contextMenu(BufferView const &, int, int) const
 940 {
 941         string context_menu = contextMenuName();
 942         if (context_menu != InsetText::contextMenuName())
 943                 context_menu += ";" + InsetText::contextMenuName();
 944         return context_menu;
 945 }
 946
 947
 948 string InsetText::contextMenuName() const
 949 {
 950         return "context-edit";
 951 }
 952
 953
 954 docstring InsetText::toolTipText(docstring prefix,
 955                 size_t numlines, size_t len) const
 956 {
 957         size_t const max_length = numlines * len;
 958         OutputParams rp(&buffer().params().encoding());
 959         odocstringstream oss;
 960         oss << prefix;
 961
 962         ParagraphList::const_iterator beg = paragraphs().begin();
 963         ParagraphList::const_iterator end = paragraphs().end();
 964         ParagraphList::const_iterator it = beg;
 965         bool ref_printed = false;
 966         docstring str;
 967
 968         for (; it != end; ++it) {
 969                 if (it != beg)
 970                         oss << '\n';
 971                 writePlaintextParagraph(buffer(), *it, oss, rp, ref_printed);
 972                 str = oss.str();
 973                 if (str.length() > max_length)
 974                         break;
 975         }
 976         return support::wrapParas(str, 4, len, numlines);
 977 }
 978
 979
 980 InsetCaption const * InsetText::getCaptionInset() const
 981 {
 982         ParagraphList::const_iterator pit = paragraphs().begin();
 983         for (; pit != paragraphs().end(); ++pit) {
 984                 InsetList::const_iterator it = pit->insetList().begin();
 985                 for (; it != pit->insetList().end(); ++it) {
 986                         Inset & inset = *it->inset;
 987                         if (inset.lyxCode() == CAPTION_CODE) {
 988                                 InsetCaption const * ins =
 989                                         static_cast<InsetCaption const *>(it->inset);
 990                                 return ins;
 991                         }
 992                 }
 993         }
 994         return 0;
 995 }
 996
 997
 998 docstring InsetText::getCaptionText(OutputParams const & runparams) const
 999 {
1000         InsetCaption const * ins = getCaptionInset();
1001         if (ins == 0)
1002                 return docstring();
1003
1004         odocstringstream ods;
1005         ins->getCaptionAsPlaintext(ods, runparams);
1006         return ods.str();
1007 }
1008
1009
1010 docstring InsetText::getCaptionHTML(OutputParams const & runparams) const
1011 {
1012         InsetCaption const * ins = getCaptionInset();
1013         if (ins == 0)
1014                 return docstring();
1015
1016         odocstringstream ods;
1017         XHTMLStream xs(ods);
1018         docstring def = ins->getCaptionAsHTML(xs, runparams);
1019         if (!def.empty())
1020                 // should already have been escaped
1021                 xs << XHTMLStream::ESCAPE_NONE << def << '\n';
1022         return ods.str();
1023 }
1024
1025
1026 InsetText::XHTMLOptions operator|(InsetText::XHTMLOptions a1, InsetText::XHTMLOptions a2)
1027 {
1028         return static_cast<InsetText::XHTMLOptions>((int)a1 | (int)a2);
1029 }
1030
1031 } // namespace lyx