]> git.lyx.org Git - features.git/blobdiff - src/insets/InsetText.cpp
Add basic support for cprotect
[features.git] / src / insets / InsetText.cpp
index 7680ee5fa925d8e06d4b0402c5bf143aa4ce12a5..4c560f492c7314d9297075e6005ea541fcedd3bf 100644 (file)
@@ -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);
 }
 
@@ -195,7 +195,7 @@ void InsetText::metrics(MetricsInfo & mi, Dimension & dim) const
        mi.base.textwidth -= 2 * TEXT_TO_INSET_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;
@@ -315,7 +315,7 @@ void InsetText::doDispatch(Cursor & cur, FuncRequest & cmd)
 
        case LFUN_INSET_DISSOLVE: {
                bool const main_inset = text_.isMainText();
-               bool const target_inset = cmd.argument().empty() 
+               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;
@@ -336,7 +336,7 @@ void InsetText::doDispatch(Cursor & cur, FuncRequest & cmd)
        default:
                text_.dispatch(cur, cmd);
        }
-       
+
        if (!cur.result().dispatched())
                Inset::doDispatch(cur, cmd);
 }
@@ -348,7 +348,7 @@ bool InsetText::getStatus(Cursor & cur, FuncRequest const & cmd,
        switch (cmd.action()) {
        case LFUN_INSET_DISSOLVE: {
                bool const main_inset = text_.isMainText();
-               bool const target_inset = cmd.argument().empty() 
+               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;
@@ -390,7 +390,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;
@@ -448,7 +448,7 @@ 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())
@@ -458,7 +458,9 @@ void InsetText::latex(otexstream & os, OutputParams const & runparams) const
                        // 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())
+                               os << "\\cprotect";
+                       else if (runparams.moving_arg)
                                os << "\\protect";
                        os << '\\' << from_utf8(il.latexname());
                        if (!il.latexargs().empty())
@@ -591,7 +593,7 @@ docstring InsetText::xhtml(XHTMLStream & xs, OutputParams const & runparams) con
 // One solution would be to make the footnote <span>, 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,
@@ -602,7 +604,7 @@ 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);
@@ -620,7 +622,7 @@ 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()) {
@@ -760,6 +762,19 @@ ParagraphList & InsetText::paragraphs()
 }
 
 
+bool InsetText::hasCProtectContent() const
+{
+       ParagraphList const & pars = paragraphs();
+       pit_type pend = paragraphs().size();
+       for (pit_type pit = 0; pit != pend; ++pit) {
+               Paragraph const & par = pars[pit];
+               if (par.needsCProtection())
+                       return true;
+       }
+       return false;
+}
+
+
 bool InsetText::insetAllowed(InsetCode code) const
 {
        switch (code) {
@@ -870,13 +885,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
@@ -943,7 +960,7 @@ 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);
@@ -952,10 +969,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);
 }
 
@@ -1015,7 +1032,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_);
@@ -1027,7 +1044,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;
 }
 
@@ -1068,4 +1085,35 @@ InsetText::XHTMLOptions operator|(InsetText::XHTMLOptions a1, InsetText::XHTMLOp
        return static_cast<InsetText::XHTMLOptions>((int)a1 | (int)a2);
 }
 
+
+bool InsetText::needsCProtection() const
+{
+       if (!getLayout().needsCProtect())
+               return false;
+
+       // Environments need cprotection regardless the content
+       if (getLayout().latextype() == InsetLayout::ENVIRONMENT)
+               return true;
+
+       // 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 = paragraphs().size();
+
+       for (pit_type pit = 0; pit != pend; ++pit) {
+               Paragraph const & par = pars[pit];
+               if (par.needsCProtection())
+                       return true;
+               docstring const pars = par.asString();
+               for (int k = 0; k < nchars_escape; k++) {
+                       if (contains(pars, chars_escape[k]))
+                               return true;
+               }
+       }
+       return false;
+}
+
 } // namespace lyx