3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
8 * Full author contact details are available in file CREDITS.
13 #include "InsetText.h"
15 #include "insets/InsetArgument.h"
16 #include "insets/InsetLayout.h"
18 #include "buffer_funcs.h"
20 #include "BufferParams.h"
21 #include "BufferView.h"
22 #include "CompletionList.h"
23 #include "CoordCache.h"
25 #include "CutAndPaste.h"
26 #include "DispatchResult.h"
27 #include "ErrorList.h"
28 #include "FuncRequest.h"
29 #include "FuncStatus.h"
30 #include "InsetList.h"
34 #include "LaTeXFeatures.h"
38 #include "MetricsInfo.h"
39 #include "output_docbook.h"
40 #include "output_latex.h"
41 #include "output_xhtml.h"
42 #include "OutputParams.h"
43 #include "output_plaintext.h"
44 #include "Paragraph.h"
45 #include "ParagraphParameters.h"
46 #include "ParIterator.h"
50 #include "texstream.h"
51 #include "TextClass.h"
53 #include "TextMetrics.h"
54 #include "TocBackend.h"
56 #include "frontends/alert.h"
57 #include "frontends/Painter.h"
59 #include "support/bind.h"
60 #include "support/convert.h"
61 #include "support/debug.h"
62 #include "support/gettext.h"
63 #include "support/lassert.h"
64 #include "support/lstrings.h"
65 #include "support/RefChanger.h"
71 using namespace lyx::support;
76 using graphics::PreviewLoader;
79 /////////////////////////////////////////////////////////////////////
81 InsetText::InsetText(Buffer * buf, UsePlain type)
82 : Inset(buf), drawFrame_(false), frame_color_(Color_insetframe),
83 text_(this, type == DefaultLayout)
88 InsetText::InsetText(InsetText const & in)
89 : Inset(in), text_(this, in.text_)
91 drawFrame_ = in.drawFrame_;
92 frame_color_ = in.frame_color_;
96 void InsetText::setBuffer(Buffer & buf)
98 ParagraphList::iterator end = paragraphs().end();
99 for (ParagraphList::iterator it = paragraphs().begin(); it != end; ++it)
100 it->setInsetBuffers(buf);
101 Inset::setBuffer(buf);
105 void InsetText::setMacrocontextPositionRecursive(DocIterator const & pos)
107 text_.setMacrocontextPosition(pos);
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);
125 void InsetText::clear()
127 ParagraphList & pars = paragraphs();
128 LBUFERR(!pars.empty());
130 // This is a gross hack...
131 Layout const & old_layout = pars.begin()->layout();
134 pars.push_back(Paragraph());
135 pars.begin()->setInsetOwner(this);
136 pars.begin()->setLayout(old_layout);
140 Dimension const InsetText::dimensionHelper(BufferView const & bv) const
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;
151 void InsetText::write(ostream & os) const
158 void InsetText::read(Lexer & lex)
162 // delete the initial paragraph
163 Paragraph oldpar = *paragraphs().begin();
164 paragraphs().clear();
166 lex.setContext("InsetText::read");
167 bool res = text_.read(lex, errorList, this);
170 lex.printError("Missing \\end_inset at this point. ");
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.
187 void InsetText::metrics(MetricsInfo & mi, Dimension & dim) const
189 TextMetrics & tm = mi.base.bv->textMetrics(&text_);
191 //lyxerr << "InsetText::metrics: width: " << mi.base.textwidth << endl;
193 // Hand font through to contained lyxtext:
194 tm.font_.fontInfo() = mi.base.font;
195 mi.base.textwidth -= 2 * TEXT_TO_INSET_OFFSET;
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;
204 tm.metrics(mi, dim, mi.base.textwidth);
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;
214 void InsetText::draw(PainterInfo & pi, int x, int y) const
216 TextMetrics & tm = pi.base.bv->textMetrics(&text_);
218 int const w = tm.width() + TEXT_TO_INSET_OFFSET;
219 int const yframe = y - TEXT_TO_INSET_OFFSET - tm.ascent();
220 int const h = tm.height() + 2 * TEXT_TO_INSET_OFFSET;
221 int const xframe = x + TEXT_TO_INSET_OFFSET / 2;
222 bool change_drawn = false;
223 if (drawFrame_ || pi.full_repaint) {
225 pi.pain.fillRectangle(xframe, yframe, w, h,
226 pi.backgroundColor(this));
228 // Change color of the frame in tracked changes, like for tabulars.
229 // Only do so if the color is not custom. But do so even if RowPainter
230 // handles the strike-through already.
232 if (pi.change_.changed()
233 // Originally, these are the colors with role Text, from role() in
234 // ColorCache.cpp. The code is duplicated to avoid depending on Qt
235 // types, and also maybe it need not match in the future.
236 && (frameColor() == Color_foreground
237 || frameColor() == Color_cursor
238 || frameColor() == Color_preview
239 || frameColor() == Color_tabularline
240 || frameColor() == Color_previewframe)) {
241 c = pi.change_.color();
246 pi.pain.rectangle(xframe, yframe, w, h, c);
249 Changer dummy = make_change(pi.background_color,
250 pi.backgroundColor(this, false));
251 // The change tracking cue must not be inherited
252 Changer dummy2 = make_change(pi.change_, Change());
253 tm.draw(pi, x + TEXT_TO_INSET_OFFSET, y);
255 if (canPaintChange(*pi.base.bv) && (!change_drawn || pi.change_.deleted()))
256 // Do not draw the change tracking cue if already done by RowPainter and
257 // do not draw the cue for INSERTED if the information is already in the
258 // color of the frame
259 pi.change_.paintCue(pi, xframe, yframe, xframe + w, yframe + h);
263 void InsetText::edit(Cursor & cur, bool front, EntryDirection entry_from)
265 pit_type const pit = front ? 0 : paragraphs().size() - 1;
266 pos_type pos = front ? 0 : paragraphs().back().size();
268 // if visual information is not to be ignored, move to extreme right/left
269 if (entry_from != ENTRY_DIRECTION_IGNORE) {
270 Cursor temp_cur = cur;
271 temp_cur.pit() = pit;
272 temp_cur.pos() = pos;
273 temp_cur.posVisToRowExtremity(entry_from == ENTRY_DIRECTION_LEFT);
274 pos = temp_cur.pos();
277 cur.top().setPitPos(pit, pos);
282 Inset * InsetText::editXY(Cursor & cur, int x, int y)
284 return cur.bv().textMetrics(&text_).editXY(cur, x, y);
288 void InsetText::doDispatch(Cursor & cur, FuncRequest & cmd)
290 LYXERR(Debug::ACTION, "InsetText::doDispatch(): cmd: " << cmd);
292 // See bug #9042, for instance.
294 // Force any new text to latex_language FIXME: This
295 // should only be necessary in constructor, but new
296 // paragraphs that are created by pressing enter at
297 // the start of an existing paragraph get the buffer
298 // language and not latex_language, so we take this
299 // brute force approach.
300 cur.current_font.setLanguage(latex_language);
301 cur.real_current_font.setLanguage(latex_language);
304 switch (cmd.action()) {
306 case LFUN_CLIPBOARD_PASTE:
307 case LFUN_SELECTION_PASTE:
308 case LFUN_PRIMARY_SELECTION_PASTE:
309 text_.dispatch(cur, cmd);
310 // If we we can only store plain text, we must reset all
312 // FIXME: Change only the pasted paragraphs
316 case LFUN_INSET_DISSOLVE: {
317 bool const main_inset = text_.isMainText();
318 bool const target_inset = cmd.argument().empty()
319 || cmd.getArg(0) == insetName(lyxCode());
320 // cur.inset() is the tabular when this is a single cell (bug #9954)
321 bool const one_cell = cur.inset().nargs() == 1;
323 if (!main_inset && target_inset && one_cell) {
324 // Text::dissolveInset assumes that the cursor
325 // is inside the Inset.
326 if (&cur.inset() != this)
327 cur.pushBackward(*this);
328 cur.beginUndoGroup();
329 text_.dispatch(cur, cmd);
337 text_.dispatch(cur, cmd);
340 if (!cur.result().dispatched())
341 Inset::doDispatch(cur, cmd);
345 bool InsetText::getStatus(Cursor & cur, FuncRequest const & cmd,
346 FuncStatus & status) const
348 switch (cmd.action()) {
349 case LFUN_INSET_DISSOLVE: {
350 bool const main_inset = text_.isMainText();
351 bool const target_inset = cmd.argument().empty()
352 || cmd.getArg(0) == insetName(lyxCode());
353 // cur.inset() is the tabular when this is a single cell (bug #9954)
354 bool const one_cell = cur.inset().nargs() == 1;
357 status.setEnabled(!main_inset && one_cell);
361 case LFUN_ARGUMENT_INSERT: {
362 string const arg = cmd.getArg(0);
364 status.setEnabled(false);
367 if (text_.isMainText() || !cur.paragraph().layout().args().empty())
368 return text_.getStatus(cur, cmd, status);
370 Layout::LaTeXArgMap args = getLayout().args();
371 Layout::LaTeXArgMap::const_iterator const lait = args.find(arg);
372 if (lait != args.end()) {
373 status.setEnabled(true);
374 for (Paragraph const & par : paragraphs())
375 for (auto const & table : par.insetList())
376 if (InsetArgument const * ins = table.inset->asInsetArgument())
377 if (ins->name() == arg) {
378 // we have this already
379 status.setEnabled(false);
383 status.setEnabled(false);
388 // Dispatch only to text_ if the cursor is inside
389 // the text_. It is not for context menus (bug 5797).
391 if (cur.text() == &text_)
392 ret = text_.getStatus(cur, cmd, status);
395 ret = Inset::getStatus(cur, cmd, status);
401 void InsetText::fixParagraphsFont()
403 Font font(inherit_font, buffer().params().language);
404 font.setLanguage(latex_language);
405 ParagraphList::iterator par = paragraphs().begin();
406 ParagraphList::iterator const end = paragraphs().end();
408 if (par->isPassThru())
409 par->resetFonts(font);
410 if (!par->allowParagraphCustomization())
411 par->params().clear();
417 void InsetText::setChange(Change const & change)
419 ParagraphList::iterator pit = paragraphs().begin();
420 ParagraphList::iterator end = paragraphs().end();
421 for (; pit != end; ++pit) {
422 pit->setChange(change);
427 void InsetText::acceptChanges()
429 text_.acceptChanges();
433 void InsetText::rejectChanges()
435 text_.rejectChanges();
439 void InsetText::validate(LaTeXFeatures & features) const
441 features.useInsetLayout(getLayout());
442 for (Paragraph const & p : paragraphs())
443 p.validate(features);
447 void InsetText::latex(otexstream & os, OutputParams const & runparams) const
449 // This implements the standard way of handling the LaTeX
450 // output of a text inset, either a command or an
451 // environment. Standard collapsible insets should not
452 // redefine this, non-standard ones may call this.
453 InsetLayout const & il = getLayout();
454 if (il.forceOwnlines())
456 if (!il.latexname().empty()) {
457 if (il.latextype() == InsetLayout::COMMAND) {
459 // FIXME \protect should only be used for fragile
460 // commands, but we do not provide this information yet.
461 if (hasCProtectContent(runparams.moving_arg))
463 else if (runparams.moving_arg)
465 os << '\\' << from_utf8(il.latexname());
466 if (!il.latexargs().empty())
467 getArgs(os, runparams);
468 if (!il.latexparam().empty())
469 os << from_utf8(il.latexparam());
471 } else if (il.latextype() == InsetLayout::ENVIRONMENT) {
476 if (runparams.lastid != -1)
477 os.texrow().start(runparams.lastid,
479 os << "\\begin{" << from_utf8(il.latexname()) << "}";
480 if (!il.latexargs().empty())
481 getArgs(os, runparams);
482 if (!il.latexparam().empty())
483 os << from_utf8(il.latexparam());
487 if (!il.latexargs().empty())
488 getArgs(os, runparams);
489 if (!il.latexparam().empty())
490 os << from_utf8(il.latexparam());
493 if (!il.leftdelim().empty())
494 os << il.leftdelim();
496 OutputParams rp = runparams;
499 if (il.isNeedProtect())
500 rp.moving_arg = true;
501 if (!il.passThruChars().empty())
502 rp.pass_thru_chars += il.passThruChars();
504 rp.par_end = paragraphs().size();
506 // Output the contents of the inset
507 latexParagraphs(buffer(), text_, os, rp);
508 runparams.encoding = rp.encoding;
510 if (!il.rightdelim().empty())
511 os << il.rightdelim();
513 if (!il.latexname().empty()) {
514 if (il.latextype() == InsetLayout::COMMAND) {
516 if (!il.postcommandargs().empty())
517 getArgs(os, runparams, true);
518 } else if (il.latextype() == InsetLayout::ENVIRONMENT) {
519 // A comment environment doesn't need a % before \n\end
520 if (il.isDisplay() || runparams.inComment)
524 os << "\\end{" << from_utf8(il.latexname()) << "}" << breakln;
526 os.protectSpace(true);
529 if (il.forceOwnlines())
534 int InsetText::plaintext(odocstringstream & os,
535 OutputParams const & runparams, size_t max_length) const
537 ParagraphList::const_iterator beg = paragraphs().begin();
538 ParagraphList::const_iterator end = paragraphs().end();
539 ParagraphList::const_iterator it = beg;
540 bool ref_printed = false;
542 for (; it != end; ++it) {
545 if (runparams.linelen > 0)
548 odocstringstream oss;
549 writePlaintextParagraph(buffer(), *it, oss, runparams, ref_printed, max_length);
550 docstring const str = oss.str();
552 // FIXME: len is not computed fully correctly; in principle,
553 // we have to count the characters after the last '\n'
555 if (os.str().size() >= max_length)
563 int InsetText::docbook(odocstream & os, OutputParams const & runparams) const
565 ParagraphList::const_iterator const beg = paragraphs().begin();
568 sgml::openTag(os, getLayout().latexname(),
569 beg->getID(buffer(), runparams) + getLayout().latexparam());
571 docbookParagraphs(text_, buffer(), os, runparams);
574 sgml::closeTag(os, getLayout().latexname());
580 docstring InsetText::xhtml(XHTMLStream & xs, OutputParams const & runparams) const
582 return insetAsXHTML(xs, runparams, WriteEverything);
587 // There are cases where we may need to close open fonts and such
588 // and then re-open them when we are done. This would be the case, e.g.,
589 // if we were otherwise about to write:
590 // <em>word <div class='foot'>footnote text.</div> emph</em>
591 // The problem isn't so much that the footnote text will get emphasized:
592 // we can handle that with CSS. The problem is that this is invalid XHTML.
593 // One solution would be to make the footnote <span>, but the problem is
594 // completely general, and so we'd have to make absolutely everything into
595 // span. What I think will work is to check if we're about to write "div" and,
596 // if so, try to close fonts, etc.
597 // There are probably limits to how well we can do here, though, and we will
598 // have to rely upon users not putting footnotes inside noun-type insets.
599 docstring InsetText::insetAsXHTML(XHTMLStream & xs, OutputParams const & rp,
600 XHTMLOptions opts) const
602 // we will always want to output all our paragraphs when we are
604 OutputParams runparams = rp;
605 runparams.par_begin = 0;
606 runparams.par_end = text().paragraphs().size();
609 xs.startDivision(false);
610 xhtmlParagraphs(text_, buffer(), xs, runparams);
615 InsetLayout const & il = getLayout();
616 if (opts & WriteOuterTag)
617 xs << html::StartTag(il.htmltag(), il.htmlattr());
619 if ((opts & WriteLabel) && !il.counter().empty()) {
620 BufferParams const & bp = buffer().masterBuffer()->params();
621 Counters & cntrs = bp.documentClass().counters();
622 cntrs.step(il.counter(), OutputUpdate);
623 // FIXME: translate to paragraph language
624 if (!il.htmllabel().empty()) {
625 docstring const lbl =
626 cntrs.counterLabel(from_utf8(il.htmllabel()), bp.language->code());
627 // FIXME is this check necessary?
629 xs << html::StartTag(il.htmllabeltag(), il.htmllabelattr());
631 xs << html::EndTag(il.htmllabeltag());
636 if (opts & WriteInnerTag)
637 xs << html::StartTag(il.htmlinnertag(), il.htmlinnerattr());
639 // we will eventually lose information about the containing inset
640 if (!allowMultiPar() || opts == JustText)
641 runparams.html_make_pars = false;
643 runparams.pass_thru = true;
645 xs.startDivision(false);
646 xhtmlParagraphs(text_, buffer(), xs, runparams);
649 if (opts & WriteInnerTag)
650 xs << html::EndTag(il.htmlinnertag());
652 if (opts & WriteOuterTag)
653 xs << html::EndTag(il.htmltag());
659 void InsetText::getArgs(otexstream & os, OutputParams const & runparams_in,
660 bool const post) const
662 OutputParams runparams = runparams_in;
663 runparams.local_font =
664 ¶graphs()[0].getFirstFontSettings(buffer().masterBuffer()->params());
666 runparams.pass_thru = true;
668 latexArgInsetsForParent(paragraphs(), os, runparams,
669 getLayout().postcommandargs(), "post:");
671 latexArgInsetsForParent(paragraphs(), os, runparams,
672 getLayout().latexargs());
676 void InsetText::cursorPos(BufferView const & bv,
677 CursorSlice const & sl, bool boundary, int & x, int & y) const
679 x = bv.textMetrics(&text_).cursorX(sl, boundary) + TEXT_TO_INSET_OFFSET;
680 y = bv.textMetrics(&text_).cursorY(sl, boundary);
684 void InsetText::setText(docstring const & data, Font const & font, bool trackChanges)
687 Paragraph & first = paragraphs().front();
688 for (unsigned int i = 0; i < data.length(); ++i)
689 first.insertChar(i, data[i], font, trackChanges);
693 void InsetText::setDrawFrame(bool flag)
699 ColorCode InsetText::frameColor() const
705 void InsetText::setFrameColor(ColorCode col)
711 void InsetText::appendParagraphs(ParagraphList & plist)
713 // There is little we can do here to keep track of changes.
714 // As of 2006/10/20, appendParagraphs is used exclusively by
715 // LyXTabular::setMultiColumn. In this context, the paragraph break
716 // is lost irreversibly and the appended text doesn't really change
718 ParagraphList & pl = paragraphs();
720 ParagraphList::iterator pit = plist.begin();
721 ParagraphList::iterator ins = pl.insert(pl.end(), *pit);
723 mergeParagraph(buffer().params(), pl,
724 distance(pl.begin(), ins) - 1);
726 for_each(pit, plist.end(),
727 bind(&ParagraphList::push_back, ref(pl), _1));
731 void InsetText::addPreview(DocIterator const & text_inset_pos,
732 PreviewLoader & loader) const
734 ParagraphList::const_iterator pit = paragraphs().begin();
735 ParagraphList::const_iterator pend = paragraphs().end();
738 DocIterator inset_pos = text_inset_pos;
739 inset_pos.push_back(CursorSlice(*const_cast<InsetText *>(this)));
741 for (; pit != pend; ++pit, ++pidx) {
742 InsetList::const_iterator it = pit->insetList().begin();
743 InsetList::const_iterator end = pit->insetList().end();
744 inset_pos.pit() = pidx;
745 for (; it != end; ++it) {
746 inset_pos.pos() = it->pos;
747 it->inset->addPreview(inset_pos, loader);
753 ParagraphList const & InsetText::paragraphs() const
755 return text_.paragraphs();
759 ParagraphList & InsetText::paragraphs()
761 return text_.paragraphs();
765 bool InsetText::hasCProtectContent(bool const fragile) const
767 ParagraphList const & pars = paragraphs();
768 pit_type pend = paragraphs().size();
769 for (pit_type pit = 0; pit != pend; ++pit) {
770 Paragraph const & par = pars[pit];
771 if (par.needsCProtection(fragile))
778 bool InsetText::insetAllowed(InsetCode code) const
781 // Arguments and (plain) quotes are also allowed in PassThru insets
786 return !isPassThru();
791 void InsetText::updateBuffer(ParIterator const & it, UpdateType utype)
793 ParIterator it2 = it;
795 LASSERT(&it2.inset() == this && it2.pit() == 0, return);
796 if (producesOutput()) {
797 InsetLayout const & il = getLayout();
798 bool const save_layouts = utype == OutputUpdate && il.htmlisblock();
799 Counters & cnt = buffer().masterBuffer()->params().documentClass().counters();
801 // LYXERR0("Entering " << name());
802 cnt.clearLastLayout();
803 // FIXME cnt.saveLastCounter()?
805 buffer().updateBuffer(it2, utype);
807 // LYXERR0("Exiting " << name());
808 cnt.restoreLastLayout();
809 // FIXME cnt.restoreLastCounter()?
812 DocumentClass const & tclass = buffer().masterBuffer()->params().documentClass();
813 // Note that we do not need to call:
814 // tclass.counters().clearLastLayout()
815 // since we are saving and restoring the existing counters, etc.
816 Counters const savecnt = tclass.counters();
817 tclass.counters().reset();
818 // we need float information even in note insets (#9760)
819 tclass.counters().current_float(savecnt.current_float());
820 tclass.counters().isSubfloat(savecnt.isSubfloat());
821 buffer().updateBuffer(it2, utype);
822 tclass.counters() = savecnt;
827 void InsetText::toString(odocstream & os) const
829 os << text().asString(0, 1, AS_STR_LABEL | AS_STR_INSETS);
833 void InsetText::forOutliner(docstring & os, size_t const maxlen,
834 bool const shorten) const
836 if (!getLayout().isInToc())
838 text().forOutliner(os, maxlen, shorten);
842 void InsetText::addToToc(DocIterator const & cdit, bool output_active,
843 UpdateType utype, TocBackend & backend) const
845 DocIterator dit = cdit;
846 dit.push_back(CursorSlice(const_cast<InsetText &>(*this)));
847 iterateForToc(dit, output_active, utype, backend);
851 void InsetText::iterateForToc(DocIterator const & cdit, bool output_active,
852 UpdateType utype, TocBackend & backend) const
854 DocIterator dit = cdit;
855 // This also ensures that any document has a table of contents
856 shared_ptr<Toc> toc = backend.toc("tableofcontents");
858 BufferParams const & bufparams = buffer_->params();
859 int const min_toclevel = bufparams.documentClass().min_toclevel();
860 // we really should have done this before we got here, but it
861 // can't hurt too much to do it again
862 bool const doing_output = output_active && producesOutput();
864 // For each paragraph,
865 // * Add a toc item for the paragraph if it is AddToToc--merging adjacent
866 // paragraphs as needed.
867 // * Traverse its insets and let them add their toc items
868 // * Compute the main table of contents (this is hardcoded)
869 // * Add the list of changes
870 ParagraphList const & pars = paragraphs();
871 pit_type pend = paragraphs().size();
872 // Record pairs {start,end} of where a toc item was opened for a paragraph
873 // and where it must be closed
874 stack<pair<pit_type, pit_type>> addtotoc_stack;
876 for (pit_type pit = 0; pit != pend; ++pit) {
877 Paragraph const & par = pars[pit];
881 // Custom AddToToc in paragraph layouts (i.e. theorems)
882 if (par.layout().addToToc() && text().isFirstInSequence(pit)) {
884 openAddToTocForParagraph(pit, dit, output_active, backend);
885 addtotoc_stack.push({pit, end});
888 // If we find an InsetArgument that is supposed to provide the TOC caption,
889 // we'll save it for use later.
890 InsetArgument const * arginset = nullptr;
891 for (auto const & table : par.insetList()) {
892 dit.pos() = table.pos;
893 table.inset->addToToc(dit, doing_output, utype, backend);
894 if (InsetArgument const * x = table.inset->asInsetArgument())
895 if (x->isTocCaption())
899 // End custom AddToToc in paragraph layouts
900 while (!addtotoc_stack.empty() && addtotoc_stack.top().second == pit) {
901 // execute the closing function
902 closeAddToTocForParagraph(addtotoc_stack.top().first,
903 addtotoc_stack.top().second, backend);
904 addtotoc_stack.pop();
907 // now the toc entry for the paragraph in the main table of contents
908 int const toclevel = text().getTocLevel(pit);
909 if (toclevel != Layout::NOT_IN_TOC && toclevel >= min_toclevel) {
910 // insert this into the table of contents
912 int const length = (doing_output && utype == OutputUpdate) ?
913 INT_MAX : TOC_ENTRY_LENGTH;
915 tocstring = par.labelString();
916 if (!tocstring.empty())
918 arginset->text().forOutliner(tocstring, length);
920 par.forOutliner(tocstring, length);
922 toc->push_back(TocItem(dit, toclevel - min_toclevel,
923 tocstring, doing_output));
926 // And now the list of changes.
927 par.addChangesToToc(dit, buffer(), doing_output, backend);
932 pit_type InsetText::openAddToTocForParagraph(pit_type pit,
933 DocIterator const & dit,
935 TocBackend & backend) const
937 Paragraph const & par = paragraphs()[pit];
938 TocBuilder & b = backend.builder(par.layout().tocType());
939 docstring const label = par.labelString();
940 b.pushItem(dit, label + (label.empty() ? "" : " "), output_active);
941 return text().lastInSequence(pit);
945 void InsetText::closeAddToTocForParagraph(pit_type start, pit_type end,
946 TocBackend & backend) const
948 Paragraph const & par = paragraphs()[start];
949 TocBuilder & b = backend.builder(par.layout().tocType());
950 if (par.layout().isTocCaption()) {
952 text().forOutliner(str, TOC_ENTRY_LENGTH, start, end);
959 bool InsetText::notifyCursorLeaves(Cursor const & old, Cursor & cur)
961 if (buffer().isClean())
962 return Inset::notifyCursorLeaves(old, cur);
964 // find text inset in old cursor
965 Cursor insetCur = old;
966 int scriptSlice = insetCur.find(this);
967 // we can try to continue here. returning true means
968 // the cursor is "now" invalid. which it was.
969 LASSERT(scriptSlice != -1, return true);
970 insetCur.cutOff(scriptSlice);
971 LASSERT(&insetCur.inset() == this, return true);
973 // update the old paragraph's words
974 insetCur.paragraph().updateWords();
976 return Inset::notifyCursorLeaves(old, cur);
980 bool InsetText::completionSupported(Cursor const & cur) const
982 //LASSERT(&cur.bv().cursor().inset() == this, return false);
983 return text_.completionSupported(cur);
987 bool InsetText::inlineCompletionSupported(Cursor const & cur) const
989 return completionSupported(cur);
993 bool InsetText::automaticInlineCompletion() const
995 return lyxrc.completion_inline_text;
999 bool InsetText::automaticPopupCompletion() const
1001 return lyxrc.completion_popup_text;
1005 bool InsetText::showCompletionCursor() const
1007 return lyxrc.completion_cursor_text;
1011 CompletionList const * InsetText::createCompletionList(Cursor const & cur) const
1013 return completionSupported(cur) ? text_.createCompletionList(cur) : 0;
1017 docstring InsetText::completionPrefix(Cursor const & cur) const
1019 if (!completionSupported(cur))
1021 return text_.completionPrefix(cur);
1025 bool InsetText::insertCompletion(Cursor & cur, docstring const & s,
1028 if (!completionSupported(cur))
1031 return text_.insertCompletion(cur, s, finished);
1035 void InsetText::completionPosAndDim(Cursor const & cur, int & x, int & y,
1036 Dimension & dim) const
1038 TextMetrics const & tm = cur.bv().textMetrics(&text_);
1039 tm.completionPosAndDim(cur, x, y, dim);
1043 string InsetText::contextMenu(BufferView const &, int, int) const
1045 string context_menu = contextMenuName();
1046 if (context_menu != InsetText::contextMenuName())
1047 context_menu += ";" + InsetText::contextMenuName();
1048 return context_menu;
1052 string InsetText::contextMenuName() const
1054 return "context-edit";
1058 docstring InsetText::toolTipText(docstring prefix, size_t const len) const
1060 OutputParams rp(&buffer().params().encoding());
1061 rp.for_tooltip = true;
1062 odocstringstream oss;
1065 ParagraphList::const_iterator beg = paragraphs().begin();
1066 ParagraphList::const_iterator end = paragraphs().end();
1067 ParagraphList::const_iterator it = beg;
1068 bool ref_printed = false;
1070 for (; it != end; ++it) {
1073 writePlaintextParagraph(buffer(), *it, oss, rp, ref_printed, len);
1074 if (oss.tellp() >= 0 && size_t(oss.tellp()) > len)
1077 docstring str = oss.str();
1078 support::truncateWithEllipsis(str, len);
1083 InsetText::XHTMLOptions operator|(InsetText::XHTMLOptions a1, InsetText::XHTMLOptions a2)
1085 return static_cast<InsetText::XHTMLOptions>((int)a1 | (int)a2);
1089 bool InsetText::needsCProtection(bool const maintext, bool const fragile) const
1091 // Nested cprotect content needs \cprotect
1093 if (hasCProtectContent(fragile))
1096 // Environments generally need cprotection in fragile context
1097 if (fragile && getLayout().latextype() == InsetLayout::ENVIRONMENT)
1100 if (!getLayout().needsCProtect())
1103 // Environments and "no latex" types (e.g., knitr chunks)
1104 // need cprotection regardless the content
1105 if (!maintext && getLayout().latextype() != InsetLayout::COMMAND)
1108 // Commands need cprotection if they contain specific chars
1109 int const nchars_escape = 9;
1110 static char_type const chars_escape[nchars_escape] = {
1111 '&', '_', '$', '%', '#', '^', '{', '}', '\\'};
1113 ParagraphList const & pars = paragraphs();
1114 pit_type pend = paragraphs().size();
1116 for (pit_type pit = 0; pit != pend; ++pit) {
1117 Paragraph const & par = pars[pit];
1118 if (par.needsCProtection(fragile))
1120 docstring const pars = par.asString();
1121 for (int k = 0; k < nchars_escape; k++) {
1122 if (contains(pars, chars_escape[k]))