X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetText.cpp;h=10b15c88edad34abd39a31fb90b9223ff2700e91;hb=48b1e8a0aca2f3f3faa8f1f800568e47792ba9a0;hp=660826309f33931a0121a51113a65a9c8a08c009;hpb=26308c1d6bb8bfe5c891f3d8d8fc1ddf30248ba5;p=lyx.git diff --git a/src/insets/InsetText.cpp b/src/insets/InsetText.cpp index 660826309f..10b15c88ed 100644 --- a/src/insets/InsetText.cpp +++ b/src/insets/InsetText.cpp @@ -27,7 +27,6 @@ #include "ErrorList.h" #include "FuncRequest.h" #include "FuncStatus.h" -#include "InsetCaption.h" #include "InsetList.h" #include "Intl.h" #include "Language.h" @@ -39,15 +38,15 @@ #include "MetricsInfo.h" #include "output_docbook.h" #include "output_latex.h" +#include "output_plaintext.h" #include "output_xhtml.h" #include "OutputParams.h" -#include "output_plaintext.h" #include "Paragraph.h" #include "ParagraphParameters.h" #include "ParIterator.h" #include "Row.h" -#include "sgml.h" #include "TexRow.h" +#include "texstream.h" #include "TextClass.h" #include "Text.h" #include "TextMetrics.h" @@ -59,10 +58,9 @@ #include "support/convert.h" #include "support/debug.h" #include "support/gettext.h" -#include "support/lstrings.h" - -#include "support/bind.h" #include "support/lassert.h" +#include "support/lstrings.h" +#include "support/RefChanger.h" #include @@ -79,17 +77,18 @@ using graphics::PreviewLoader; ///////////////////////////////////////////////////////////////////// InsetText::InsetText(Buffer * buf, UsePlain type) - : Inset(buf), drawFrame_(false), frame_color_(Color_insetframe), + : Inset(buf), drawFrame_(false), is_changed_(false), intitle_context_(false), + frame_color_(Color_insetframe), text_(this, type == DefaultLayout) { } InsetText::InsetText(InsetText const & in) - : Inset(in), text_(this, in.text_) + : Inset(in), drawFrame_(in.drawFrame_), is_changed_(in.is_changed_), + intitle_context_(false), frame_color_(in.frame_color_), + text_(this, in.text_) { - drawFrame_ = in.drawFrame_; - frame_color_ = in.frame_color_; } @@ -97,7 +96,7 @@ void InsetText::setBuffer(Buffer & buf) { ParagraphList::iterator end = paragraphs().end(); for (ParagraphList::iterator it = paragraphs().begin(); it != end; ++it) - it->setBuffer(buf); + it->setInsetBuffers(buf); Inset::setBuffer(buf); } @@ -137,13 +136,13 @@ void InsetText::clear() } -Dimension const InsetText::dimension(BufferView const & bv) const +Dimension const InsetText::dimensionHelper(BufferView const & bv) const { TextMetrics const & tm = bv.textMetrics(&text_); - Dimension dim = tm.dimension(); - dim.wid += 2 * TEXT_TO_INSET_OFFSET; - dim.des += TEXT_TO_INSET_OFFSET; - dim.asc += TEXT_TO_INSET_OFFSET; + Dimension dim = tm.dim(); + dim.wid += leftOffset(&bv) + rightOffset(&bv); + dim.des += bottomOffset(&bv); + dim.asc += topOffset(&bv); return dim; } @@ -190,12 +189,14 @@ void InsetText::metrics(MetricsInfo & mi, Dimension & dim) const //lyxerr << "InsetText::metrics: width: " << mi.base.textwidth << endl; + int const horiz_offset = leftOffset(mi.base.bv) + rightOffset(mi.base.bv); + // Hand font through to contained lyxtext: tm.font_.fontInfo() = mi.base.font; - mi.base.textwidth -= 2 * TEXT_TO_INSET_OFFSET; + mi.base.textwidth -= horiz_offset; // This can happen when a layout has a left and right margin, - // and the view is made very narrow. We can't do better than + // and the view is made very narrow. We can't do better than // to draw it partly out of view (bug 5890). if (mi.base.textwidth < 1) mi.base.textwidth = 1; @@ -204,10 +205,10 @@ void InsetText::metrics(MetricsInfo & mi, Dimension & dim) const tm.metrics(mi, dim, mi.base.textwidth); else tm.metrics(mi, dim); - mi.base.textwidth += 2 * TEXT_TO_INSET_OFFSET; - dim.asc += TEXT_TO_INSET_OFFSET; - dim.des += TEXT_TO_INSET_OFFSET; - dim.wid += 2 * TEXT_TO_INSET_OFFSET; + mi.base.textwidth += horiz_offset; + dim.asc += topOffset(mi.base.bv); + dim.des += bottomOffset(mi.base.bv); + dim.wid += horiz_offset; } @@ -215,24 +216,50 @@ void InsetText::draw(PainterInfo & pi, int x, int y) const { TextMetrics & tm = pi.base.bv->textMetrics(&text_); - if (drawFrame_ || pi.full_repaint) { - int const w = tm.width() + TEXT_TO_INSET_OFFSET; - int const yframe = y - TEXT_TO_INSET_OFFSET - tm.ascent(); - int const h = tm.height() + 2 * TEXT_TO_INSET_OFFSET; - int const xframe = x + TEXT_TO_INSET_OFFSET / 2; - if (pi.full_repaint) + int const horiz_offset = leftOffset(pi.base.bv) + rightOffset(pi.base.bv); + int const w = tm.width() + (horiz_offset - horiz_offset / 2); + int const yframe = y - topOffset(pi.base.bv) - tm.ascent(); + int const h = tm.height() + topOffset(pi.base.bv) + bottomOffset(pi.base.bv); + int const xframe = x + leftOffset(pi.base.bv) / 2; + bool change_drawn = false; + if (pi.full_repaint) pi.pain.fillRectangle(xframe, yframe, w, h, pi.backgroundColor(this)); - if (drawFrame_) - pi.pain.rectangle(xframe, yframe, w, h, frameColor()); + { + Changer dummy = make_change(pi.background_color, + pi.backgroundColor(this, false)); + // The change tracking cue must not be inherited + Changer dummy2 = make_change(pi.change, Change()); + tm.draw(pi, x + leftOffset(pi.base.bv), y); } - ColorCode const old_color = pi.background_color; - pi.background_color = pi.backgroundColor(this, false); - tm.draw(pi, x + TEXT_TO_INSET_OFFSET, y); + if (drawFrame_) { + // Change color of the frame in tracked changes, like for tabulars. + // Only do so if the color is not custom. But do so even if RowPainter + // handles the strike-through already. + Color c; + if (pi.change.changed() + // Originally, these are the colors with role Text, from role() in + // ColorCache.cpp. The code is duplicated to avoid depending on Qt + // types, and also maybe it need not match in the future. + && (frameColor() == Color_foreground + || frameColor() == Color_cursor + || frameColor() == Color_preview + || frameColor() == Color_tabularline + || frameColor() == Color_previewframe)) { + c = pi.change.color(); + change_drawn = true; + } else + c = frameColor(); + pi.pain.rectangle(xframe, yframe, w, h, c); + } - pi.background_color = old_color; + if (canPaintChange(*pi.base.bv) && (!change_drawn || pi.change.deleted())) + // Do not draw the change tracking cue if already done by RowPainter and + // do not draw the cue for INSERTED if the information is already in the + // color of the frame + pi.change.paintCue(pi, xframe, yframe, xframe + w, yframe + h); } @@ -250,7 +277,7 @@ void InsetText::edit(Cursor & cur, bool front, EntryDirection entry_from) pos = temp_cur.pos(); } - text_.setCursor(cur.top(), pit, pos); + cur.top().setPitPos(pit, pos); cur.finishUndo(); } @@ -266,7 +293,7 @@ void InsetText::doDispatch(Cursor & cur, FuncRequest & cmd) LYXERR(Debug::ACTION, "InsetText::doDispatch(): cmd: " << cmd); // See bug #9042, for instance. - if (isPassThru() && lyxCode() != ARG_CODE) { + if (isPassThru()) { // Force any new text to latex_language FIXME: This // should only be necessary in constructor, but new // paragraphs that are created by pressing enter at @@ -290,13 +317,11 @@ void InsetText::doDispatch(Cursor & cur, FuncRequest & cmd) break; case LFUN_INSET_DISSOLVE: { - bool const main_inset = &buffer().inset() == this; - bool const target_inset = cmd.argument().empty() + bool const main_inset = text_.isMainText(); + bool const target_inset = cmd.argument().empty() || cmd.getArg(0) == insetName(lyxCode()); - // cur.inset() is the tabular when this is a single cell (bug #9954) - bool const one_cell = cur.inset().nargs() == 1; - if (!main_inset && target_inset && one_cell) { + if (!main_inset && target_inset) { // Text::dissolveInset assumes that the cursor // is inside the Inset. if (&cur.inset() != this) @@ -312,7 +337,7 @@ void InsetText::doDispatch(Cursor & cur, FuncRequest & cmd) default: text_.dispatch(cur, cmd); } - + if (!cur.result().dispatched()) Inset::doDispatch(cur, cmd); } @@ -323,14 +348,12 @@ bool InsetText::getStatus(Cursor & cur, FuncRequest const & cmd, { switch (cmd.action()) { case LFUN_INSET_DISSOLVE: { - bool const main_inset = &buffer().inset() == this; - bool const target_inset = cmd.argument().empty() + bool const main_inset = text_.isMainText(); + bool const target_inset = cmd.argument().empty() || cmd.getArg(0) == insetName(lyxCode()); - // cur.inset() is the tabular when this is a single cell (bug #9954) - bool const one_cell = cur.inset().nargs() == 1; if (target_inset) - status.setEnabled(!main_inset && one_cell); + status.setEnabled(!main_inset); return target_inset; } @@ -340,29 +363,21 @@ bool InsetText::getStatus(Cursor & cur, FuncRequest const & cmd, status.setEnabled(false); return true; } - if (&buffer().inset() == this || !cur.paragraph().layout().args().empty()) + if (text_.isMainText() || !cur.paragraph().layout().args().empty()) return text_.getStatus(cur, cmd, status); Layout::LaTeXArgMap args = getLayout().args(); Layout::LaTeXArgMap::const_iterator const lait = args.find(arg); if (lait != args.end()) { status.setEnabled(true); - ParagraphList::const_iterator pit = paragraphs().begin(); - for (; pit != paragraphs().end(); ++pit) { - InsetList::const_iterator it = pit->insetList().begin(); - InsetList::const_iterator end = pit->insetList().end(); - for (; it != end; ++it) { - if (it->inset->lyxCode() == ARG_CODE) { - InsetArgument const * ins = - static_cast(it->inset); + for (Paragraph const & par : paragraphs()) + for (auto const & table : par.insetList()) + if (InsetArgument const * ins = table.inset->asInsetArgument()) if (ins->name() == arg) { // we have this already status.setEnabled(false); return true; } - } - } - } } else status.setEnabled(false); return true; @@ -374,7 +389,7 @@ bool InsetText::getStatus(Cursor & cur, FuncRequest const & cmd, bool ret = false; if (cur.text() == &text_) ret = text_.getStatus(cur, cmd, status); - + if (!ret) ret = Inset::getStatus(cur, cmd, status); return ret; @@ -398,6 +413,18 @@ void InsetText::fixParagraphsFont() } +// bool InsetText::isChanged() const +// { +// ParagraphList::const_iterator pit = paragraphs().begin(); +// ParagraphList::const_iterator end = paragraphs().end(); +// for (; pit != end; ++pit) { +// if (pit->isChanged()) +// return true; +// } +// return false; +// } + + void InsetText::setChange(Change const & change) { ParagraphList::iterator pit = paragraphs().begin(); @@ -423,8 +450,8 @@ void InsetText::rejectChanges() void InsetText::validate(LaTeXFeatures & features) const { features.useInsetLayout(getLayout()); - for_each(paragraphs().begin(), paragraphs().end(), - bind(&Paragraph::validate, _1, ref(features))); + for (Paragraph const & p : paragraphs()) + p.validate(features); } @@ -432,17 +459,25 @@ void InsetText::latex(otexstream & os, OutputParams const & runparams) const { // This implements the standard way of handling the LaTeX // output of a text inset, either a command or an - // environment. Standard collapsable insets should not + // environment. Standard collapsible insets should not // redefine this, non-standard ones may call this. InsetLayout const & il = getLayout(); if (il.forceOwnlines()) os << breakln; + bool needendgroup = false; if (!il.latexname().empty()) { if (il.latextype() == InsetLayout::COMMAND) { // FIXME UNICODE // FIXME \protect should only be used for fragile // commands, but we do not provide this information yet. - if (runparams.moving_arg) + if (hasCProtectContent(runparams.moving_arg)) { + if (contains(runparams.active_chars, '^')) { + // cprotect relies on ^ being on catcode 7 + os << "\\begingroup\\catcode`\\^=7"; + needendgroup = true; + } + os << "\\cprotect"; + } else if (runparams.moving_arg) os << "\\protect"; os << '\\' << from_utf8(il.latexname()); if (!il.latexargs().empty()) @@ -480,14 +515,23 @@ void InsetText::latex(otexstream & os, OutputParams const & runparams) const rp.pass_thru = true; if (il.isNeedProtect()) rp.moving_arg = true; + if (il.isNeedMBoxProtect()) + ++rp.inulemcmd; if (!il.passThruChars().empty()) rp.pass_thru_chars += il.passThruChars(); + if (!il.newlineCmd().empty()) + rp.newlinecmd = il.newlineCmd(); rp.par_begin = 0; rp.par_end = paragraphs().size(); // Output the contents of the inset latexParagraphs(buffer(), text_, os, rp); runparams.encoding = rp.encoding; + // Pass the post_macros upstream + runparams.post_macro = rp.post_macro; + // These need to be passed upstream as well + runparams.need_maketitle = rp.need_maketitle; + runparams.have_maketitle = rp.have_maketitle; if (!il.rightdelim().empty()) os << il.rightdelim(); @@ -497,6 +541,8 @@ void InsetText::latex(otexstream & os, OutputParams const & runparams) const os << "}"; if (!il.postcommandargs().empty()) getArgs(os, runparams, true); + if (needendgroup) + os << "\\endgroup"; } else if (il.latextype() == InsetLayout::ENVIRONMENT) { // A comment environment doesn't need a % before \n\end if (il.isDisplay() || runparams.inComment) @@ -524,7 +570,7 @@ int InsetText::plaintext(odocstringstream & os, for (; it != end; ++it) { if (it != beg) { os << '\n'; - if (runparams.linelen > 0) + if (runparams.linelen > 0 && !getLayout().parbreakIsNewline()) os << '\n'; } odocstringstream oss; @@ -542,24 +588,56 @@ int InsetText::plaintext(odocstringstream & os, } -int InsetText::docbook(odocstream & os, OutputParams const & runparams) const + +void InsetText::docbook(XMLStream & xs, OutputParams const & rp) const { - ParagraphList::const_iterator const beg = paragraphs().begin(); + docbook(xs, rp, WriteEverything); +} - if (!undefined()) - sgml::openTag(os, getLayout().latexname(), - beg->getID(buffer(), runparams) + getLayout().latexparam()); - docbookParagraphs(text_, buffer(), os, runparams); +void InsetText::docbook(XMLStream & xs, OutputParams const & rp, XHTMLOptions opts) const +{ + // we will always want to output all our paragraphs when we are + // called this way. + OutputParams runparams = rp; + runparams.par_begin = 0; + runparams.par_end = text().paragraphs().size(); - if (!undefined()) - sgml::closeTag(os, getLayout().latexname()); + if (undefined()) { + xs.startDivision(false); + docbookParagraphs(text_, buffer(), xs, runparams); + xs.endDivision(); + return; + } + + InsetLayout const & il = getLayout(); + if (opts & WriteOuterTag && !il.docbooktag().empty() && il.docbooktag() != "NONE") { + docstring attrs = docstring(); + if (!il.docbookattr().empty()) + attrs += from_ascii(il.docbookattr()); + if (il.docbooktag() == "link") + attrs += from_ascii(" xlink:href=\"") + text_.asString() + from_ascii("\""); + xs << xml::StartTag(il.docbooktag(), attrs); + } + + // No need for labels that are generated from counters. - return 0; + // With respect to XHTML, paragraphs are still allowed here. + if (!allowMultiPar()) + runparams.docbook_make_pars = false; + if (il.isPassThru()) + runparams.pass_thru = true; + + xs.startDivision(false); + docbookParagraphs(text_, buffer(), xs, runparams); + xs.endDivision(); + + if (opts & WriteOuterTag) + xs << xml::EndTag(il.docbooktag()); } -docstring InsetText::xhtml(XHTMLStream & xs, OutputParams const & runparams) const +docstring InsetText::xhtml(XMLStream & xs, OutputParams const & runparams) const { return insetAsXHTML(xs, runparams, WriteEverything); } @@ -575,10 +653,10 @@ docstring InsetText::xhtml(XHTMLStream & xs, OutputParams const & runparams) con // One solution would be to make the footnote , but the problem is // completely general, and so we'd have to make absolutely everything into // span. What I think will work is to check if we're about to write "div" and, -// if so, try to close fonts, etc. +// if so, try to close fonts, etc. // There are probably limits to how well we can do here, though, and we will // have to rely upon users not putting footnotes inside noun-type insets. -docstring InsetText::insetAsXHTML(XHTMLStream & xs, OutputParams const & rp, +docstring InsetText::insetAsXHTML(XMLStream & xs, OutputParams const & rp, XHTMLOptions opts) const { // we will always want to output all our paragraphs when we are @@ -586,15 +664,17 @@ docstring InsetText::insetAsXHTML(XHTMLStream & xs, OutputParams const & rp, OutputParams runparams = rp; runparams.par_begin = 0; runparams.par_end = text().paragraphs().size(); - + if (undefined()) { + xs.startDivision(false); xhtmlParagraphs(text_, buffer(), xs, runparams); + xs.endDivision(); return docstring(); } InsetLayout const & il = getLayout(); if (opts & WriteOuterTag) - xs << html::StartTag(il.htmltag(), il.htmlattr()); + xs << xml::StartTag(il.htmltag(), il.htmlattr()); if ((opts & WriteLabel) && !il.counter().empty()) { BufferParams const & bp = buffer().masterBuffer()->params(); @@ -602,19 +682,19 @@ docstring InsetText::insetAsXHTML(XHTMLStream & xs, OutputParams const & rp, cntrs.step(il.counter(), OutputUpdate); // FIXME: translate to paragraph language if (!il.htmllabel().empty()) { - docstring const lbl = + docstring const lbl = cntrs.counterLabel(from_utf8(il.htmllabel()), bp.language->code()); // FIXME is this check necessary? if (!lbl.empty()) { - xs << html::StartTag(il.htmllabeltag(), il.htmllabelattr()); + xs << xml::StartTag(il.htmllabeltag(), il.htmllabelattr()); xs << lbl; - xs << html::EndTag(il.htmllabeltag()); + xs << xml::EndTag(il.htmllabeltag()); } } } if (opts & WriteInnerTag) - xs << html::StartTag(il.htmlinnertag(), il.htmlinnerattr()); + xs << xml::StartTag(il.htmlinnertag(), il.htmlinnerattr()); // we will eventually lose information about the containing inset if (!allowMultiPar() || opts == JustText) @@ -622,17 +702,20 @@ docstring InsetText::insetAsXHTML(XHTMLStream & xs, OutputParams const & rp, if (il.isPassThru()) runparams.pass_thru = true; + xs.startDivision(false); xhtmlParagraphs(text_, buffer(), xs, runparams); + xs.endDivision(); if (opts & WriteInnerTag) - xs << html::EndTag(il.htmlinnertag()); + xs << xml::EndTag(il.htmlinnertag()); if (opts & WriteOuterTag) - xs << html::EndTag(il.htmltag()); + xs << xml::EndTag(il.htmltag()); return docstring(); } + void InsetText::getArgs(otexstream & os, OutputParams const & runparams_in, bool const post) const { @@ -642,16 +725,18 @@ void InsetText::getArgs(otexstream & os, OutputParams const & runparams_in, if (isPassThru()) runparams.pass_thru = true; if (post) - latexArgInsets(paragraphs(), paragraphs().begin(), os, runparams, getLayout().postcommandargs(), "post:"); + latexArgInsetsForParent(paragraphs(), os, runparams, + getLayout().postcommandargs(), "post:"); else - latexArgInsets(paragraphs(), paragraphs().begin(), os, runparams, getLayout().latexargs()); + latexArgInsetsForParent(paragraphs(), os, runparams, + getLayout().latexargs()); } void InsetText::cursorPos(BufferView const & bv, CursorSlice const & sl, bool boundary, int & x, int & y) const { - x = bv.textMetrics(&text_).cursorX(sl, boundary) + TEXT_TO_INSET_OFFSET; + x = bv.textMetrics(&text_).cursorX(sl, boundary) + leftOffset(&bv); y = bv.textMetrics(&text_).cursorY(sl, boundary); } @@ -698,8 +783,9 @@ void InsetText::appendParagraphs(ParagraphList & plist) mergeParagraph(buffer().params(), pl, distance(pl.begin(), ins) - 1); - for_each(pit, plist.end(), - bind(&ParagraphList::push_back, ref(pl), _1)); + ParagraphList::iterator const pend = plist.end(); + for (; pit != pend; ++pit) + pl.push_back(*pit); } @@ -737,11 +823,26 @@ ParagraphList & InsetText::paragraphs() } +bool InsetText::hasCProtectContent(bool fragile) const +{ + fragile |= getLayout().isNeedProtect(); + ParagraphList const & pars = paragraphs(); + pit_type pend = pit_type(paragraphs().size()); + for (pit_type pit = 0; pit != pend; ++pit) { + Paragraph const & par = pars[size_type(pit)]; + if (par.needsCProtection(fragile)) + return true; + } + return false; +} + + bool InsetText::insetAllowed(InsetCode code) const { switch (code) { - // Arguments are also allowed in PassThru insets + // Arguments and (plain) quotes are also allowed in PassThru insets case ARG_CODE: + case QUOTE_CODE: return true; default: return !isPassThru(); @@ -749,7 +850,7 @@ bool InsetText::insetAllowed(InsetCode code) const } -void InsetText::updateBuffer(ParIterator const & it, UpdateType utype) +void InsetText::updateBuffer(ParIterator const & it, UpdateType utype, bool const deleted) { ParIterator it2 = it; it2.forwardPos(); @@ -763,24 +864,35 @@ void InsetText::updateBuffer(ParIterator const & it, UpdateType utype) cnt.clearLastLayout(); // FIXME cnt.saveLastCounter()? } - buffer().updateBuffer(it2, utype); + buffer().updateBuffer(it2, utype, deleted); if (save_layouts) { // LYXERR0("Exiting " << name()); cnt.restoreLastLayout(); // FIXME cnt.restoreLastCounter()? } + // Record in this inset is embedded in a title layout + // This is needed to decide when \maketitle is output. + intitle_context_ = it.paragraph().layout().intitle; + // Also check embedding layouts + size_t const n = it.depth(); + for (size_t i = 0; i < n; ++i) { + if (it[i].paragraph().layout().intitle) { + intitle_context_ = true; + break; + } + } } else { DocumentClass const & tclass = buffer().masterBuffer()->params().documentClass(); // Note that we do not need to call: // tclass.counters().clearLastLayout() // since we are saving and restoring the existing counters, etc. - Counters const savecnt = tclass.counters(); + Counters savecnt = tclass.counters(); tclass.counters().reset(); // we need float information even in note insets (#9760) tclass.counters().current_float(savecnt.current_float()); tclass.counters().isSubfloat(savecnt.isSubfloat()); - buffer().updateBuffer(it2, utype); - tclass.counters() = savecnt; + buffer().updateBuffer(it2, utype, deleted); + tclass.counters() = move(savecnt); } } @@ -801,20 +913,20 @@ void InsetText::forOutliner(docstring & os, size_t const maxlen, void InsetText::addToToc(DocIterator const & cdit, bool output_active, - UpdateType utype) const + UpdateType utype, TocBackend & backend) const { DocIterator dit = cdit; dit.push_back(CursorSlice(const_cast(*this))); - iterateForToc(dit, output_active, utype); + iterateForToc(dit, output_active, utype, backend); } void InsetText::iterateForToc(DocIterator const & cdit, bool output_active, - UpdateType utype) const + UpdateType utype, TocBackend & backend) const { DocIterator dit = cdit; // This also ensures that any document has a table of contents - shared_ptr toc = buffer().tocBackend().toc("tableofcontents"); + shared_ptr toc = backend.toc("tableofcontents"); BufferParams const & bufparams = buffer_->params(); int const min_toclevel = bufparams.documentClass().min_toclevel(); @@ -822,26 +934,50 @@ void InsetText::iterateForToc(DocIterator const & cdit, bool output_active, // can't hurt too much to do it again bool const doing_output = output_active && producesOutput(); - // For each paragraph, traverse its insets and let them add - // their toc items + // For each paragraph, + // * Add a toc item for the paragraph if it is AddToToc--merging adjacent + // paragraphs as needed. + // * Traverse its insets and let them add their toc items + // * Compute the main table of contents (this is hardcoded) + // * Add the list of changes ParagraphList const & pars = paragraphs(); pit_type pend = paragraphs().size(); + // Record pairs {start,end} of where a toc item was opened for a paragraph + // and where it must be closed + stack> addtotoc_stack; + for (pit_type pit = 0; pit != pend; ++pit) { Paragraph const & par = pars[pit]; dit.pit() = pit; - // if we find an optarg, we'll save it for use later. - InsetText const * arginset = 0; - InsetList::const_iterator it = par.insetList().begin(); - InsetList::const_iterator end = par.insetList().end(); - for (; it != end; ++it) { - Inset & inset = *it->inset; - dit.pos() = it->pos; - //lyxerr << (void*)&inset << " code: " << inset.lyxCode() << std::endl; - inset.addToToc(dit, doing_output, utype); - if (inset.lyxCode() == ARG_CODE) - arginset = inset.asInsetText(); + dit.pos() = 0; + + // Custom AddToToc in paragraph layouts (i.e. theorems) + if (par.layout().addToToc() && text().isFirstInSequence(pit)) { + pit_type end = + openAddToTocForParagraph(pit, dit, output_active, backend); + addtotoc_stack.push({pit, end}); + } + + // If we find an InsetArgument that is supposed to provide the TOC caption, + // we'll save it for use later. + InsetArgument const * arginset = nullptr; + for (auto const & table : par.insetList()) { + dit.pos() = table.pos; + table.inset->addToToc(dit, doing_output, utype, backend); + if (InsetArgument const * x = table.inset->asInsetArgument()) + if (x->isTocCaption()) + arginset = x; + } + + // End custom AddToToc in paragraph layouts + while (!addtotoc_stack.empty() && addtotoc_stack.top().second == pit) { + // execute the closing function + closeAddToTocForParagraph(addtotoc_stack.top().first, + addtotoc_stack.top().second, backend); + addtotoc_stack.pop(); } - // now the toc entry for the paragraph + + // now the toc entry for the paragraph in the main table of contents int const toclevel = text().getTocLevel(pit); if (toclevel != Layout::NOT_IN_TOC && toclevel >= min_toclevel) { // insert this into the table of contents @@ -857,20 +993,47 @@ void InsetText::iterateForToc(DocIterator const & cdit, bool output_active, par.forOutliner(tocstring, length); dit.pos() = 0; toc->push_back(TocItem(dit, toclevel - min_toclevel, - tocstring, doing_output, tocstring)); + tocstring, doing_output)); } - + // And now the list of changes. - par.addChangesToToc(dit, buffer(), doing_output); + par.addChangesToToc(dit, buffer(), doing_output, backend); } } +pit_type InsetText::openAddToTocForParagraph(pit_type pit, + DocIterator const & dit, + bool output_active, + TocBackend & backend) const +{ + Paragraph const & par = paragraphs()[pit]; + TocBuilder & b = backend.builder(par.layout().tocType()); + docstring const label = par.labelString(); + b.pushItem(dit, label + (label.empty() ? "" : " "), output_active); + return text().lastInSequence(pit); +} + + +void InsetText::closeAddToTocForParagraph(pit_type start, pit_type end, + TocBackend & backend) const +{ + Paragraph const & par = paragraphs()[start]; + TocBuilder & b = backend.builder(par.layout().tocType()); + if (par.layout().isTocCaption()) { + docstring str; + text().forOutliner(str, TOC_ENTRY_LENGTH, start, end); + b.argumentItem(str); + } + b.pop(); +} + + bool InsetText::notifyCursorLeaves(Cursor const & old, Cursor & cur) { if (buffer().isClean()) return Inset::notifyCursorLeaves(old, cur); - + // find text inset in old cursor Cursor insetCur = old; int scriptSlice = insetCur.find(this); @@ -879,10 +1042,10 @@ bool InsetText::notifyCursorLeaves(Cursor const & old, Cursor & cur) LASSERT(scriptSlice != -1, return true); insetCur.cutOff(scriptSlice); LASSERT(&insetCur.inset() == this, return true); - + // update the old paragraph's words insetCur.paragraph().updateWords(); - + return Inset::notifyCursorLeaves(old, cur); } @@ -942,7 +1105,7 @@ bool InsetText::insertCompletion(Cursor & cur, docstring const & s, } -void InsetText::completionPosAndDim(Cursor const & cur, int & x, int & y, +void InsetText::completionPosAndDim(Cursor const & cur, int & x, int & y, Dimension & dim) const { TextMetrics const & tm = cur.bv().textMetrics(&text_); @@ -954,7 +1117,7 @@ string InsetText::contextMenu(BufferView const &, int, int) const { string context_menu = contextMenuName(); if (context_menu != InsetText::contextMenuName()) - context_menu += ";" + InsetText::contextMenuName(); + context_menu += ";" + InsetText::contextMenuName(); return context_menu; } @@ -965,10 +1128,8 @@ string InsetText::contextMenuName() const } -docstring InsetText::toolTipText(docstring prefix, - size_t numlines, size_t len) const +docstring InsetText::toolTipText(docstring prefix, size_t const len) const { - size_t const max_length = numlines * len; OutputParams rp(&buffer().params().encoding()); rp.for_tooltip = true; odocstringstream oss; @@ -978,69 +1139,73 @@ docstring InsetText::toolTipText(docstring prefix, ParagraphList::const_iterator end = paragraphs().end(); ParagraphList::const_iterator it = beg; bool ref_printed = false; - docstring str; for (; it != end; ++it) { if (it != beg) oss << '\n'; - writePlaintextParagraph(buffer(), *it, oss, rp, ref_printed, max_length); - str = oss.str(); - if (str.length() >= max_length) + if ((*it).isRTL(buffer().params())) + oss << "
"; + writePlaintextParagraph(buffer(), *it, oss, rp, ref_printed, len); + if (oss.tellp() >= 0 && size_t(oss.tellp()) > len) break; } - return support::wrapParas(str, 4, len, numlines); + docstring str = oss.str(); + if (isChanged()) + str += from_ascii("\n\n") + _("[contains tracked changes]"); + support::truncateWithEllipsis(str, len); + return str; } -InsetCaption const * InsetText::getCaptionInset() const +InsetText::XHTMLOptions operator|(InsetText::XHTMLOptions a1, InsetText::XHTMLOptions a2) { - ParagraphList::const_iterator pit = paragraphs().begin(); - for (; pit != paragraphs().end(); ++pit) { - InsetList::const_iterator it = pit->insetList().begin(); - for (; it != pit->insetList().end(); ++it) { - Inset & inset = *it->inset; - if (inset.lyxCode() == CAPTION_CODE) { - InsetCaption const * ins = - static_cast(it->inset); - return ins; - } - } - } - return 0; + return static_cast((int)a1 | (int)a2); } -docstring InsetText::getCaptionText(OutputParams const & runparams) const +bool InsetText::needsCProtection(bool const maintext, bool const fragile) const { - InsetCaption const * ins = getCaptionInset(); - if (ins == 0) - return docstring(); + // Nested cprotect content needs \cprotect + // on each level + if (producesOutput() && hasCProtectContent(fragile)) + return true; - odocstringstream ods; - ins->getCaptionAsPlaintext(ods, runparams); - return ods.str(); -} + // Environments generally need cprotection in fragile context + if (fragile && getLayout().latextype() == InsetLayout::ENVIRONMENT) + return true; + if (!getLayout().needsCProtect()) + return false; -docstring InsetText::getCaptionHTML(OutputParams const & runparams) const -{ - InsetCaption const * ins = getCaptionInset(); - if (ins == 0) - return docstring(); + // Environments and "no latex" types (e.g., knitr chunks) + // need cprotection regardless the content + if (!maintext && getLayout().latextype() != InsetLayout::COMMAND) + return true; - odocstringstream ods; - XHTMLStream xs(ods); - docstring def = ins->getCaptionAsHTML(xs, runparams); - if (!def.empty()) - // should already have been escaped - xs << XHTMLStream::ESCAPE_NONE << def << '\n'; - return ods.str(); -} + // If the inset does not produce output (e.g. Note or Branch), + // we can ignore the contained paragraphs + if (!producesOutput()) + return false; + // Commands need cprotection if they contain specific chars + int const nchars_escape = 9; + static char_type const chars_escape[nchars_escape] = { + '&', '_', '$', '%', '#', '^', '{', '}', '\\'}; -InsetText::XHTMLOptions operator|(InsetText::XHTMLOptions a1, InsetText::XHTMLOptions a2) -{ - return static_cast((int)a1 | (int)a2); + ParagraphList const & pars = paragraphs(); + pit_type pend = pit_type(paragraphs().size()); + + for (pit_type pit = 0; pit != pend; ++pit) { + Paragraph const & par = pars[size_type(pit)]; + if (par.needsCProtection(fragile)) + return true; + docstring const par_str = par.asString(); + for (int k = 0; k < nchars_escape; k++) { + if (contains(par_str, chars_escape[k])) + return true; + } + } + return false; } } // namespace lyx