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