]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetText.cpp
requires is a keyword in C++2a
[lyx.git] / src / insets / InsetText.cpp
index 28484a4d76114704eb6725d6d5eeaeef35669774..3d7de487f6d1b224327d4bc36a999e8079ed75a8 100644 (file)
@@ -79,17 +79,17 @@ using graphics::PreviewLoader;
 /////////////////////////////////////////////////////////////////////
 
 InsetText::InsetText(Buffer * buf, UsePlain type)
-       : Inset(buf), drawFrame_(false), frame_color_(Color_insetframe),
+       : Inset(buf), drawFrame_(false), is_changed_(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_),
+         frame_color_(in.frame_color_),
+         text_(this, in.text_)
 {
-       drawFrame_ = in.drawFrame_;
-       frame_color_ = in.frame_color_;
 }
 
 
@@ -97,7 +97,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);
 }
 
@@ -140,10 +140,10 @@ void InsetText::clear()
 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,9 +190,11 @@ 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
@@ -204,10 +206,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,21 +217,30 @@ void InsetText::draw(PainterInfo & pi, int x, int y) const
 {
        TextMetrics & tm = pi.base.bv->textMetrics(&text_);
 
-       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;
+       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 (drawFrame_ || pi.full_repaint) {
-               if (pi.full_repaint)
+       if (pi.full_repaint)
                        pi.pain.fillRectangle(xframe, yframe, w, h,
                                pi.backgroundColor(this));
 
+       {
+               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);
+       }
+
+       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()
+               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.
@@ -238,25 +249,18 @@ void InsetText::draw(PainterInfo & pi, int x, int y) const
                        || frameColor() == Color_preview
                        || frameColor() == Color_tabularline
                        || frameColor() == Color_previewframe)) {
-                       c = pi.change_.color();
+                       c = pi.change.color();
                        change_drawn = true;
                } else
                        c = frameColor();
-               if (drawFrame_)
-                       pi.pain.rectangle(xframe, yframe, w, h, c);
-       }
-       {
-               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 + TEXT_TO_INSET_OFFSET, y);
+               pi.pain.rectangle(xframe, yframe, w, h, c);
        }
-       if (canPaintChange(*pi.base.bv) && (!change_drawn || pi.change_.deleted()))
+
+       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);
+               pi.change.paintCue(pi, xframe, yframe, xframe + w, yframe + h);
 }
 
 
@@ -317,10 +321,8 @@ void InsetText::doDispatch(Cursor & cur, FuncRequest & cmd)
                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)
@@ -350,11 +352,9 @@ bool InsetText::getStatus(Cursor & cur, FuncRequest const & cmd,
                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;
        }
 
@@ -414,6 +414,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();
@@ -453,12 +465,20 @@ void InsetText::latex(otexstream & os, OutputParams const & runparams) const
        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())
@@ -496,14 +516,20 @@ 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;
 
        if (!il.rightdelim().empty())
                os << il.rightdelim();
@@ -513,6 +539,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)
@@ -674,7 +702,7 @@ void InsetText::getArgs(otexstream & os, OutputParams const & runparams_in,
 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);
 }
 
@@ -760,6 +788,20 @@ 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) {
@@ -773,7 +815,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();
@@ -787,7 +829,7 @@ 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();
@@ -798,13 +840,13 @@ void InsetText::updateBuffer(ParIterator const & it, UpdateType utype)
                // 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);
        }
 }
 
@@ -870,13 +912,15 @@ void InsetText::iterateForToc(DocIterator const & cdit, bool output_active,
                        addtotoc_stack.push({pit, end});
                }
 
-               // if we find an optarg, we'll save it for use later.
+               // 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())
-                               arginset = x;
+                               if (x->isTocCaption())
+                                       arginset = x;
                }
 
                // End custom AddToToc in paragraph layouts
@@ -1053,11 +1097,15 @@ docstring InsetText::toolTipText(docstring prefix, size_t const len) const
        for (; it != end; ++it) {
                if (it != beg)
                        oss << '\n';
+               if ((*it).isRTL(buffer().params()))
+                       oss << "<div dir=\"rtl\">";
                writePlaintextParagraph(buffer(), *it, oss, rp, ref_printed, len);
                if (oss.tellp() >= 0 && size_t(oss.tellp()) > len)
                        break;
        }
        docstring str = oss.str();
+       if (isChanged())
+               str += from_ascii("\n\n") + _("[contains tracked changes]");
        support::truncateWithEllipsis(str, len);
        return str;
 }
@@ -1068,4 +1116,50 @@ InsetText::XHTMLOptions operator|(InsetText::XHTMLOptions a1, InsetText::XHTMLOp
        return static_cast<InsetText::XHTMLOptions>((int)a1 | (int)a2);
 }
 
+
+bool InsetText::needsCProtection(bool const maintext, bool const fragile) const
+{
+       // Nested cprotect content needs \cprotect
+       // on each level
+       if (producesOutput() && hasCProtectContent(fragile))
+               return true;
+
+       // Environments generally need cprotection in fragile context
+       if (fragile && getLayout().latextype() == InsetLayout::ENVIRONMENT)
+               return true;
+
+       if (!getLayout().needsCProtect())
+               return false;
+
+       // Environments and "no latex" types (e.g., knitr chunks)
+       // need cprotection regardless the content
+       if (!maintext && getLayout().latextype() != InsetLayout::COMMAND)
+               return true;
+
+       // 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] = {
+               '&', '_', '$', '%', '#', '^', '{', '}', '\\'};
+
+       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