]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetBox.cpp
Loop refactoring
[lyx.git] / src / insets / InsetBox.cpp
index 90523c5c08953db7d0fd950f8b4822653e8c5ca4..d714cf7853f6a9e1d33484231cfbc92bc9bee5fc 100644 (file)
@@ -26,6 +26,7 @@
 #include "LaTeXFeatures.h"
 #include "Lexer.h"
 #include "MetricsInfo.h"
+#include "output_docbook.h"
 #include "output_xhtml.h"
 #include "TexRow.h"
 #include "texstream.h"
@@ -102,7 +103,7 @@ BoxTranslatorLoc const & boxtranslator_loc()
 /////////////////////////////////////////////////////////////////////////
 
 InsetBox::InsetBox(Buffer * buffer, string const & label)
-       : InsetCollapsable(buffer), params_(label)
+       : InsetCollapsible(buffer), params_(label)
 {}
 
 
@@ -116,14 +117,14 @@ docstring InsetBox::layoutName() const
 void InsetBox::write(ostream & os) const
 {
        params_.write(os);
-       InsetCollapsable::write(os);
+       InsetCollapsible::write(os);
 }
 
 
 void InsetBox::read(Lexer & lex)
 {
        params_.read(lex);
-       InsetCollapsable::read(lex);
+       InsetCollapsible::read(lex);
 }
 
 
@@ -165,7 +166,7 @@ void InsetBox::setButtonLabel()
        if (btype == Boxed)
                setFrameColor(lcolor.getFromLaTeXName(params_.framecolor));
        else
-               setFrameColor(Color_collapsableframe);
+               setFrameColor(Color_collapsibleframe);
 }
 
 
@@ -182,15 +183,15 @@ bool InsetBox::allowMultiPar() const
 }
 
 
-void InsetBox::metrics(MetricsInfo & m, Dimension & dim) const
+void InsetBox::metrics(MetricsInfo & mi, Dimension & dim) const
 {
        // back up textwidth.
-       int textwidth_backup = m.base.textwidth;
+       int textwidth_backup = mi.base.textwidth;
        if (hasFixedWidth())
-               m.base.textwidth = params_.width.inPixels(m.base);
-       InsetCollapsable::metrics(m, dim);
-       // retore textwidth.
-       m.base.textwidth = textwidth_backup;
+               mi.base.textwidth = mi.base.inPixels(params_.width);
+       InsetCollapsible::metrics(mi, dim);
+       // restore textwidth.
+       mi.base.textwidth = textwidth_backup;
 }
 
 
@@ -201,6 +202,17 @@ bool InsetBox::forcePlainLayout(idx_type) const
 }
 
 
+bool InsetBox::needsCProtection(bool const maintext, bool const fragile) const
+{
+       // We need to cprotect boxes that use minipages as inner box
+       // in fragile context
+       if (fragile && params_.inner_box && !params_.use_parbox && !params_.use_makebox)
+               return true;
+
+       return InsetText::needsCProtection(maintext, fragile);
+}
+
+
 ColorCode InsetBox::backgroundColor(PainterInfo const &) const
 {
        // we only support background color for 3 types
@@ -227,7 +239,9 @@ ColorCode InsetBox::backgroundColor(PainterInfo const &) const
 
 LyXAlignment InsetBox::contentAlignment() const
 {
-       if (!params_.use_makebox)
+       // Custom horizontal alignment is only allowed with a fixed width
+       // and if either makebox or no inner box are used
+       if (params_.width.empty() || !(params_.use_makebox || !params_.inner_box))
                return LYX_ALIGN_NONE;
 
        // The default value below is actually irrelevant
@@ -268,7 +282,7 @@ void InsetBox::doDispatch(Cursor & cur, FuncRequest & cmd)
                cur.recordUndoInset(this);
                if (change_type) {
                        params_.type = cmd.getArg(1);
-                       // set a makebox if there is no inner box but Frameless was exectued
+                       // set a makebox if there is no inner box but Frameless was executed
                        // otherwise the result would be a non existent box (no inner AND outer box)
                        // (this was LyX bug 8712)
                        if (params_.type == "Frameless" && !params_.inner_box) {
@@ -287,7 +301,7 @@ void InsetBox::doDispatch(Cursor & cur, FuncRequest & cmd)
        }
 
        default:
-               InsetCollapsable::doDispatch(cur, cmd);
+               InsetCollapsible::doDispatch(cur, cmd);
                break;
        }
 }
@@ -310,7 +324,7 @@ bool InsetBox::getStatus(Cursor & cur, FuncRequest const & cmd,
                        flag.setEnabled(true);
                        return true;
                }
-               return InsetCollapsable::getStatus(cur, cmd, flag);
+               return InsetCollapsible::getStatus(cur, cmd, flag);
        }
 
        case LFUN_INSET_DIALOG_UPDATE:
@@ -318,7 +332,7 @@ bool InsetBox::getStatus(Cursor & cur, FuncRequest const & cmd,
                return true;
 
        default:
-               return InsetCollapsable::getStatus(cur, cmd, flag);
+               return InsetCollapsible::getStatus(cur, cmd, flag);
        }
 }
 
@@ -336,6 +350,15 @@ void InsetBox::latex(otexstream & os, OutputParams const & runparams) const
        string separation_string = params_.separation.asLatexString();
        string shadowsize_string = params_.shadowsize.asLatexString();
        bool stdwidth = false;
+       string const cprotect = hasCProtectContent(runparams.moving_arg) ? "\\cprotect" : string();
+       // Colored boxes in RTL need to be wrapped into \beginL...\endL
+       string maybeBeginL;
+       string maybeEndL;
+       bool needEndL = false;
+       if (!runparams.isFullUnicode() && runparams.local_font->isRightToLeft()) {
+               maybeBeginL = "\\beginL";
+               maybeEndL = "\\endL";
+       }
        // in general the overall width of some decorated boxes is wider thean the inner box
        // we could therefore calculate the real width for all sizes so that if the user wants
        // e.g. 0.1\columnwidth or 2cm he gets exactly this size
@@ -382,6 +405,7 @@ void InsetBox::latex(otexstream & os, OutputParams const & runparams) const
        if (stdwidth && !(buffer().params().paragraph_separation))
                os << "\\noindent";
 
+       bool needendgroup = false;
        switch (btype) {
        case Frameless:
                break;
@@ -406,8 +430,9 @@ void InsetBox::latex(otexstream & os, OutputParams const & runparams) const
                        os << "{\\fboxsep " << from_ascii(separation_string);
                if (!params_.inner_box && !width_string.empty()) {
                        if (params_.framecolor != "black" || params_.backgroundcolor != "none") {
-                               os << "\\fcolorbox{" << params_.framecolor << "}{" << params_.backgroundcolor << "}{";
+                               os << maybeBeginL << "\\fcolorbox{" << params_.framecolor << "}{" << params_.backgroundcolor << "}{";
                                os << "\\makebox";
+                               needEndL = !maybeBeginL.empty();
                        } else
                                os << "\\framebox";
                        // Special widths, see usrguide sec. 3.5
@@ -423,10 +448,17 @@ void InsetBox::latex(otexstream & os, OutputParams const & runparams) const
                        if (params_.hor_pos != 'c')
                                os << "[" << params_.hor_pos << "]";
                } else {
-                       if (params_.framecolor != "black" || params_.backgroundcolor != "none")
-                               os << "\\fcolorbox{" << params_.framecolor << "}{" << params_.backgroundcolor << "}";
-                       else
-                               os << "\\fbox";
+                       if (params_.framecolor != "black" || params_.backgroundcolor != "none") {
+                               os << maybeBeginL << "\\fcolorbox{" << params_.framecolor << "}{" << params_.backgroundcolor << "}";
+                               needEndL = !maybeBeginL.empty();
+                       } else {
+                               if (!cprotect.empty() && contains(runparams.active_chars, '^')) {
+                                       // cprotect relies on ^ being on catcode 7
+                                       os << "\\begingroup\\catcode`\\^=7";
+                                       needendgroup = true;
+                               }
+                               os << cprotect << "\\fbox";
+                       }
                }
                os << "{";
                break;
@@ -465,6 +497,8 @@ void InsetBox::latex(otexstream & os, OutputParams const & runparams) const
        case Shaded:
                // must be set later because e.g. the width settings only work when
                // it is inside a minipage or parbox
+               os << maybeBeginL;
+               needEndL = !maybeBeginL.empty();
                break;
        case Doublebox:
                if (thickness_string != defaultThick) {
@@ -480,13 +514,17 @@ void InsetBox::latex(otexstream & os, OutputParams const & runparams) const
 
        if (params_.inner_box) {
                if (params_.use_parbox) {
-                       if (params_.backgroundcolor != "none" && btype == Frameless)
-                               os << "\\colorbox{" << params_.backgroundcolor << "}{";
+                       if (params_.backgroundcolor != "none" && btype == Frameless) {
+                               os << maybeBeginL << "\\colorbox{" << params_.backgroundcolor << "}{";
+                               needEndL = !maybeBeginL.empty();
+                       }
                        os << "\\parbox";
                } else if (params_.use_makebox) {
                        if (!width_string.empty()) {
-                               if (params_.backgroundcolor != "none")
-                                       os << "\\colorbox{" << params_.backgroundcolor << "}{";
+                               if (params_.backgroundcolor != "none") {
+                                       os << maybeBeginL << "\\colorbox{" << params_.backgroundcolor << "}{";
+                                       needEndL = !maybeBeginL.empty();
+                               }
                                os << "\\makebox";
                                // FIXME UNICODE
                                // output the width and horizontal position
@@ -500,16 +538,20 @@ void InsetBox::latex(otexstream & os, OutputParams const & runparams) const
                                if (params_.hor_pos != 'c')
                                        os << "[" << params_.hor_pos << "]";
                        } else {
-                               if (params_.backgroundcolor != "none")
-                                       os << "\\colorbox{" << params_.backgroundcolor << "}";
+                               if (params_.backgroundcolor != "none") {
+                                       os << maybeBeginL << "\\colorbox{" << params_.backgroundcolor << "}";
+                                       needEndL = !maybeBeginL.empty();
+                               }
                                else
                                        os << "\\mbox";
                        }
                        os << "{";
                }
                else {
-                       if (params_.backgroundcolor != "none" && btype == Frameless)
-                               os << "\\colorbox{" << params_.backgroundcolor << "}{";
+                       if (params_.backgroundcolor != "none" && btype == Frameless) {
+                               os << maybeBeginL << "\\colorbox{" << params_.backgroundcolor << "}{";
+                               needEndL = !maybeBeginL.empty();
+                       }
                        os << "\\begin{minipage}";
                }
 
@@ -568,7 +610,7 @@ void InsetBox::latex(otexstream & os, OutputParams const & runparams) const
                break;
        case Framed:
                os << "\\end{framed}";
-               if (separation_string != defaultSep     || thickness_string != defaultThick)
+               if (separation_string != defaultSep || thickness_string != defaultThick)
                        os << "}";
                break;
        case Boxed:
@@ -576,8 +618,10 @@ void InsetBox::latex(otexstream & os, OutputParams const & runparams) const
                if (!params_.inner_box && !width_string.empty()
                        && (params_.framecolor != "black" || params_.backgroundcolor != "none"))
                        os << "}";
-               if (separation_string != defaultSep     || thickness_string != defaultThick)
+               if (separation_string != defaultSep || thickness_string != defaultThick)
                        os << "}";
+               if (needendgroup)
+                       os << "\\endgroup";
                break;
        case ovalbox:
                os << "}";
@@ -605,6 +649,8 @@ void InsetBox::latex(otexstream & os, OutputParams const & runparams) const
                // already done
                break;
        }
+       if (needEndL)
+               os << maybeEndL;
 }
 
 
@@ -670,13 +716,45 @@ int InsetBox::plaintext(odocstringstream & os,
 }
 
 
-int InsetBox::docbook(odocstream & os, OutputParams const & runparams) const
+void InsetBox::docbook(XMLStream & xs, OutputParams const & runparams) const
 {
-       return InsetText::docbook(os, runparams);
+       if (!getLayout().docbookwrappertag().empty()) {
+               if (!xs.isLastTagCR())
+                       xs << xml::CR();
+
+               xs << xml::StartTag(getLayout().docbookwrappertag(), getLayout().docbookwrapperattr());
+               xs << xml::CR();
+       } else {
+               LYXERR0("Assertion failed: box layout " + getLayout().name() + " missing DocBookWrapperTag.");
+       }
+
+       // If the box starts with a sectioning item, use as box title.
+       auto current_par = paragraphs().begin();
+       if (current_par->layout().category() == from_utf8("Sectioning")) {
+               // Only generate the first paragraph.
+               current_par = makeAny(text(), buffer(), xs, runparams, paragraphs().begin());
+       }
+
+       xs.startDivision(false);
+       // Don't call InsetText::docbook, as this would generate all paragraphs in the inset, not the ones we are
+       // interested in. The best solution would be to call docbookParagraphs with an updated OutputParams object to only
+       // generate paragraphs after the title, but it leads to strange crashes, as if text().paragraphs() then returns
+       // a smaller set of paragrphs.
+       while (current_par != paragraphs().end())
+               current_par = makeAny(text(), buffer(), xs, runparams, current_par);
+       xs.endDivision();
+
+       if (!getLayout().docbookwrappertag().empty()) {
+               if (!xs.isLastTagCR())
+                       xs << xml::CR();
+
+               xs << xml::EndTag(getLayout().docbookwrappertag());
+               xs << xml::CR();
+       }
 }
 
 
-docstring InsetBox::xhtml(XHTMLStream & xs, OutputParams const & runparams) const
+docstring InsetBox::xhtml(XMLStream & xs, OutputParams const & runparams) const
 {
        // construct attributes
        string attrs = "class='" + params_.type + "'";
@@ -692,10 +770,10 @@ docstring InsetBox::xhtml(XHTMLStream & xs, OutputParams const & runparams) cons
        if (!style.empty())
                attrs += " style='" + style + "'";
 
-       xs << html::StartTag("div", attrs);
+       xs << xml::StartTag("div", attrs);
        XHTMLOptions const opts = InsetText::WriteLabel | InsetText::WriteInnerTag;
        docstring defer = InsetText::insetAsXHTML(xs, runparams, opts);
-       xs << html::EndTag("div");
+       xs << xml::EndTag("div");
        xs << defer;
        return docstring();
 }
@@ -730,7 +808,7 @@ void InsetBox::validate(LaTeXFeatures & features) const
                features.require("framed");
                break;
        }
-       InsetCollapsable::validate(features);
+       InsetCollapsible::validate(features);
 }