]> git.lyx.org Git - features.git/blobdiff - src/insets/InsetBox.cpp
Typo
[features.git] / src / insets / InsetBox.cpp
index 0f5408751cf9be809ed8a7e7089de618ed2c6587..c04bd1e927e6bf9721ba0b13b6793766bb854699 100644 (file)
 #include "LaTeXFeatures.h"
 #include "Lexer.h"
 #include "MetricsInfo.h"
+#include "output_docbook.h"
 #include "output_xhtml.h"
+#include "TexRow.h"
+#include "texstream.h"
 #include "TextClass.h"
 
 #include "support/debug.h"
 #include "support/docstream.h"
+#include "support/FileName.h"
 #include "support/gettext.h"
 #include "support/lstrings.h"
 #include "support/Translator.h"
@@ -90,7 +94,7 @@ BoxTranslatorLoc const & boxtranslator_loc()
        return translator;
 }
 
-} // namespace anon
+} // namespace
 
 
 /////////////////////////////////////////////////////////////////////////
@@ -100,7 +104,7 @@ BoxTranslatorLoc const & boxtranslator_loc()
 /////////////////////////////////////////////////////////////////////////
 
 InsetBox::InsetBox(Buffer * buffer, string const & label)
-       : InsetCollapsable(buffer), params_(label)
+       : InsetCollapsible(buffer), params_(label)
 {}
 
 
@@ -114,14 +118,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);
 }
 
 
@@ -158,12 +162,18 @@ void InsetBox::setButtonLabel()
                label = bformat(_("%1$s (%2$s, %3$s)"),
                        type, inner, frame);
        setLabel(label);
+
+       // set the frame color for the inset if the type is Boxed
+       if (btype == Boxed)
+               setFrameColor(lcolor.getFromLaTeXName(params_.framecolor));
+       else
+               setFrameColor(Color_collapsibleframe);
 }
 
 
 bool InsetBox::hasFixedWidth() const
 {
-       return !params_.width.empty();
+       return !params_.width.empty() && params_.special == "none";
 }
 
 
@@ -174,15 +184,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;
 }
 
 
@@ -193,30 +203,67 @@ 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
        if (params_.type != "Shaded" && params_.type != "Frameless" && params_.type != "Boxed")
                return getLayout().bgcolor();
+
        if (params_.type == "Shaded") {
-               // FIXME: This hardcoded color is a hack!
-               if (buffer().params().boxbgcolor == lyx::rgbFromHexName("#ff0000"))
+               if (!buffer().params().isboxbgcolor)
                        return getLayout().bgcolor();
-               
-               ColorCode c = lcolor.getFromLyXName("boxbgcolor");
+
+               ColorCode c = lcolor.getFromLyXName("boxbgcolor@" + buffer().fileName().absFileName());
                if (c == Color_none)
                        return getLayout().bgcolor();
                return c;
-       } else {
-               if (params_.backgroundcolor == "none")
-                       return getLayout().bgcolor();
-               ColorCode boxbackground = lcolor.getFromLyXName(params_.backgroundcolor);
-               return boxbackground;
        }
+
+       if (params_.backgroundcolor != "none")
+               return lcolor.getFromLaTeXName(params_.backgroundcolor);
+
        return getLayout().bgcolor();
 }
 
 
+LyXAlignment InsetBox::contentAlignment() const
+{
+       // 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
+       LyXAlignment align = LYX_ALIGN_NONE;
+       switch (params_.hor_pos) {
+       case 'l':
+               align = LYX_ALIGN_LEFT;
+               break;
+       case 'c':
+               align = LYX_ALIGN_CENTER;
+               break;
+       case 'r':
+               align = LYX_ALIGN_RIGHT;
+               break;
+       case 's':
+               align = LYX_ALIGN_BLOCK;
+               break;
+       }
+       return align;
+}
+
+
 void InsetBox::doDispatch(Cursor & cur, FuncRequest & cmd)
 {
        switch (cmd.action()) {
@@ -233,16 +280,28 @@ void InsetBox::doDispatch(Cursor & cur, FuncRequest & cmd)
                        return;
                }
                cur.recordUndoInset(this);
-               if (change_type)
+               if (change_type) {
                        params_.type = cmd.getArg(1);
-               else // if (for_box)
+                       // 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) {
+                               params_.use_makebox = true;
+                               params_.inner_box = true;
+                       }
+                       // handle the opposite case
+                       if (params_.type == "Boxed" && params_.use_makebox) {
+                               params_.use_makebox = false;
+                               params_.inner_box = false;
+                       }
+               } else
                        string2params(to_utf8(cmd.argument()), params_);
                setButtonLabel();
                break;
        }
 
        default:
-               InsetCollapsable::doDispatch(cur, cmd);
+               InsetCollapsible::doDispatch(cur, cmd);
                break;
        }
 }
@@ -265,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:
@@ -273,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);
        }
 }
 
@@ -291,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
@@ -337,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;
@@ -361,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
@@ -374,13 +444,21 @@ void InsetBox::latex(otexstream & os, OutputParams const & runparams) const
                        } else
                                os << '[' << from_ascii(width_string)
                                   << ']';
+                       // default horizontal alignment is 'c'
                        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;
@@ -419,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) {
@@ -434,14 +514,18 @@ 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 << "}{";
-                               os << "\\makebox{";
+                               if (params_.backgroundcolor != "none") {
+                                       os << maybeBeginL << "\\colorbox{" << params_.backgroundcolor << "}{";
+                                       needEndL = !maybeBeginL.empty();
+                               }
+                               os << "\\makebox";
                                // FIXME UNICODE
                                // output the width and horizontal position
                                if (params_.special != "none") {
@@ -454,15 +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 << "\\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}";
                }
 
@@ -501,23 +590,6 @@ void InsetBox::latex(otexstream & os, OutputParams const & runparams) const
                os << "\\begin{shaded}%\n";
        }
 
-       // \framebox and \makebox handle hor_pos their own way
-       // hor_pos is senseless for \mbox and \fbox
-       if (!(params_.use_makebox)
-               && !(btype == Boxed && !params_.inner_box)) {
-                       switch (params_.hor_pos) {
-                       case 'l':
-                               // do nothing because this is LaTeX's default
-                               break;
-                       case 'c':
-                               os << "\\centering ";
-                               break;
-                       case 'r':
-                               os << "\\raggedleft ";
-                               break;
-                       }
-       }
-
        InsetText::latex(os, runparams);
 
        if (btype == Shaded)
@@ -538,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:
@@ -546,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 << "}";
@@ -575,6 +649,8 @@ void InsetBox::latex(otexstream & os, OutputParams const & runparams) const
                // already done
                break;
        }
+       if (needEndL)
+               os << maybeEndL;
 }
 
 
@@ -640,13 +716,61 @@ 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);
+       // There really should be a wrapper tag for this layout.
+       bool hasBoxTag = !getLayout().docbookwrappertag().empty();
+       if (!hasBoxTag)
+               LYXERR0("Assertion failed: box layout " + getLayout().name() + " missing DocBookWrapperTag.");
+
+       // Avoid nesting boxes in DocBook, it's not allowed. Only make the check for <sidebar> to avoid destroying
+       // tags if this is not the wrapper tag for this layout (unlikely).
+       bool isAlreadyInBox = hasBoxTag && xs.isTagOpen(xml::StartTag(getLayout().docbookwrappertag()));
+
+       bool outputBoxTag = hasBoxTag && !isAlreadyInBox;
+
+       // Generate the box tag (typically, <sidebar>).
+       if (outputBoxTag) {
+               if (!xs.isLastTagCR())
+                       xs << xml::CR();
+
+               xs << xml::StartTag(getLayout().docbookwrappertag(), getLayout().docbookwrapperattr());
+               xs << xml::CR();
+       }
+
+       // 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());
+       }
+
+       // 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.
+       // Elements in the box must keep their paragraphs.
+       auto rp = runparams;
+       rp.docbook_in_par = false;
+       rp.docbook_force_pars = true;
+
+       xs.startDivision(false);
+       while (current_par != paragraphs().end())
+               current_par = makeAny(text(), buffer(), xs, rp, current_par);
+       xs.endDivision();
+
+       // Close the box.
+       if (outputBoxTag) {
+               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 + "'";
@@ -662,10 +786,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();
 }
@@ -700,7 +824,7 @@ void InsetBox::validate(LaTeXFeatures & features) const
                features.require("framed");
                break;
        }
-       InsetCollapsable::validate(features);
+       InsetCollapsible::validate(features);
 }