* \author Angus Leeming
* \author Martin Vermeer
* \author Jürgen Spitzmüller
+ * \author Uwe Stöhr
*
* Full author contact details are available in file CREDITS.
*/
#include "Buffer.h"
#include "BufferParams.h"
#include "BufferView.h"
+#include "ColorSet.h"
#include "Cursor.h"
#include "DispatchResult.h"
#include "FuncStatus.h"
#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"
BoxTranslator const & boxtranslator()
{
- static BoxTranslator translator = initBoxtranslator();
+ static BoxTranslator const translator = initBoxtranslator();
return translator;
}
BoxTranslatorLoc const & boxtranslator_loc()
{
- static BoxTranslatorLoc translator = initBoxtranslatorLoc();
+ static BoxTranslatorLoc const translator = initBoxtranslatorLoc();
return translator;
}
-} // namespace anon
+} // namespace
/////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////
InsetBox::InsetBox(Buffer * buffer, string const & label)
- : InsetCollapsable(buffer), params_(label)
+ : InsetCollapsible(buffer), params_(label)
{}
-docstring InsetBox::name() const
+docstring InsetBox::layoutName() const
{
// FIXME: UNICODE
- string name = "Box";
- if (boxtranslator().find(params_.type) == Shaded)
- name += ":Shaded";
- return from_ascii(name);
+ return from_ascii("Box:" + params_.type);
}
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);
}
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_.inner_box || params_.special != "width";
+ return !params_.width.empty() && params_.special == "none";
+}
+
+
+bool InsetBox::allowMultiPar() const
+{
+ return (params_.inner_box && !params_.use_makebox)
+ || params_.type == "Shaded" || params_.type == "Framed";
}
-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.textwidth);
- 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;
}
}
+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"))
+ return getLayout().bgcolor();
+
+ ColorCode c = lcolor.getFromLyXName("boxbgcolor");
+ if (c == Color_none)
+ return getLayout().bgcolor();
+ return c;
+ }
+
+ 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()) {
case LFUN_INSET_MODIFY: {
//lyxerr << "InsetBox::dispatch MODIFY" << endl;
- cur.recordUndoInset(ATOMIC_UNDO, this);
- if (cmd.getArg(0) == "changetype") {
+ string const first_arg = cmd.getArg(0);
+ bool const change_type = first_arg == "changetype";
+ bool const for_box = first_arg == "box";
+ if (!change_type && !for_box) {
+ // not for us
+ // this will not be handled higher up
+ cur.undispatched();
+ return;
+ }
+ cur.recordUndoInset(this);
+ if (change_type) {
params_.type = cmd.getArg(1);
+ // 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();
}
default:
- InsetCollapsable::doDispatch(cur, cmd);
+ InsetCollapsible::doDispatch(cur, cmd);
break;
}
}
{
switch (cmd.action()) {
- case LFUN_INSET_MODIFY:
- if (cmd.getArg(0) == "changetype")
- flag.setOnOff(cmd.getArg(1) == params_.type);
- flag.setEnabled(true);
- return true;
+ case LFUN_INSET_MODIFY: {
+ string const first_arg = cmd.getArg(0);
+ if (first_arg == "changetype") {
+ string const type = cmd.getArg(1);
+ flag.setOnOff(type == params_.type);
+ flag.setEnabled(!params_.inner_box || type != "Framed");
+ return true;
+ }
+ if (first_arg == "box") {
+ flag.setEnabled(true);
+ return true;
+ }
+ return InsetCollapsible::getStatus(cur, cmd, flag);
+ }
case LFUN_INSET_DIALOG_UPDATE:
flag.setEnabled(true);
return true;
- case LFUN_BREAK_PARAGRAPH:
- if ((params_.inner_box && !params_.use_makebox)
- || params_.type == "Shaded" || params_.type == "Framed")
- return InsetCollapsable::getStatus(cur, cmd, flag);
- flag.setEnabled(false);
- return true;
-
default:
- return InsetCollapsable::getStatus(cur, cmd, flag);
+ return InsetCollapsible::getStatus(cur, cmd, flag);
}
}
-int InsetBox::latex(otexstream & os, OutputParams const & runparams) const
+const string defaultThick = "0.4pt";
+const string defaultSep = "3pt";
+const string defaultShadow = "4pt";
+
+void InsetBox::latex(otexstream & os, OutputParams const & runparams) const
{
BoxType btype = boxtranslator().find(params_.type);
string width_string = params_.width.asLatexString();
+ string thickness_string = params_.thickness.asLatexString();
+ string separation_string = params_.separation.asLatexString();
+ string shadowsize_string = params_.shadowsize.asLatexString();
bool stdwidth = false;
- if (params_.inner_box &&
- (width_string.find("1.0\\columnwidth") != string::npos
- || width_string.find("1.0\\textwidth") != string::npos)) {
+ 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
+ // however this makes problems when importing TeX code
+ // therefore only recalculate for the most common case that the box should not protrude
+ // the page margins
+ if (params_.inner_box
+ && ((width_string.find("1\\columnwidth") != string::npos
+ || width_string.find("1\\textwidth") != string::npos)
+ || width_string.find("1\\paperwidth") != string::npos
+ || width_string.find("1\\linewidth") != string::npos)) {
stdwidth = true;
switch (btype) {
case Frameless:
+ break;
case Framed:
+ width_string += " - 2\\FrameSep - 2\\FrameRule";
break;
case Boxed:
- case Shaded:
width_string += " - 2\\fboxsep - 2\\fboxrule";
break;
+ case Shaded:
+ break;
case ovalbox:
width_string += " - 2\\fboxsep - 0.8pt";
break;
width_string += " - 2\\fboxsep - 1.6pt";
break;
case Shadowbox:
- // Shadow falls outside right margin... opinions?
- width_string += " - 2\\fboxsep - 2\\fboxrule"/* "-\\shadowsize"*/;
+ width_string += " - 2\\fboxsep - 2\\fboxrule - \\shadowsize";
break;
case Doublebox:
width_string += " - 2\\fboxsep - 7.5\\fboxrule - 1pt";
}
}
- int i = 0;
- os << "%\n";
- // Adapt to column/text width correctly also if paragraphs indented:
- if (stdwidth)
+ os << safebreakln;
+ if (runparams.lastid != -1)
+ os.texrow().start(runparams.lastid, runparams.lastpos);
+
+ // adapt column/text width correctly also if paragraphs indented
+ if (stdwidth && !(buffer().params().paragraph_separation))
os << "\\noindent";
+ bool needendgroup = false;
switch (btype) {
case Frameless:
break;
case Framed:
+ if (thickness_string != defaultThick) {
+ os << "{\\FrameRule " << from_ascii(thickness_string);
+ if (separation_string != defaultSep)
+ os << "\\FrameSep " << from_ascii(separation_string);
+ }
+ if (separation_string != defaultSep && thickness_string == defaultThick)
+ os << "{\\FrameSep " << from_ascii(separation_string);
+
os << "\\begin{framed}%\n";
- i += 1;
break;
case Boxed:
- os << "\\framebox";
- if (!params_.inner_box) {
- // Special widths, see usrguide §3.5
+ if (thickness_string != defaultThick) {
+ os << "{\\fboxrule " << from_ascii(thickness_string);
+ if (separation_string != defaultSep)
+ os << "\\fboxsep " << from_ascii(separation_string);
+ }
+ if (separation_string != defaultSep && thickness_string == defaultThick)
+ os << "{\\fboxsep " << from_ascii(separation_string);
+ if (!params_.inner_box && !width_string.empty()) {
+ if (params_.framecolor != "black" || params_.backgroundcolor != "none") {
+ os << maybeBeginL << "\\fcolorbox{" << params_.framecolor << "}{" << params_.backgroundcolor << "}{";
+ os << "\\makebox";
+ needEndL = !maybeBeginL.empty();
+ } else
+ os << "\\framebox";
+ // Special widths, see usrguide sec. 3.5
// FIXME UNICODE
if (params_.special != "none") {
os << "[" << params_.width.value()
} 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 << 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;
case ovalbox:
+ if (!separation_string.empty() && separation_string != defaultSep)
+ os << "{\\fboxsep " << from_ascii(separation_string);
os << "\\ovalbox{";
break;
case Ovalbox:
+ if (!separation_string.empty() && separation_string != defaultSep)
+ os << "{\\fboxsep " << from_ascii(separation_string);
os << "\\Ovalbox{";
break;
case Shadowbox:
+ if (thickness_string != defaultThick) {
+ os << "{\\fboxrule " << from_ascii(thickness_string);
+ if (separation_string != defaultSep) {
+ os << "\\fboxsep " << from_ascii(separation_string);
+ if (shadowsize_string != defaultShadow)
+ os << "\\shadowsize " << from_ascii(shadowsize_string);
+ }
+ if (shadowsize_string != defaultShadow && separation_string == defaultSep)
+ os << "\\shadowsize " << from_ascii(shadowsize_string);
+ }
+ if (separation_string != defaultSep && thickness_string == defaultThick) {
+ os << "{\\fboxsep " << from_ascii(separation_string);
+ if (shadowsize_string != defaultShadow)
+ os << "\\shadowsize " << from_ascii(shadowsize_string);
+ }
+ if (shadowsize_string != defaultShadow
+ && separation_string == defaultSep
+ && thickness_string == defaultThick)
+ os << "{\\shadowsize " << from_ascii(shadowsize_string);
os << "\\shadowbox{";
break;
case Shaded:
- // later
+ // 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) {
+ os << "{\\fboxrule " << from_ascii(thickness_string);
+ if (separation_string != defaultSep)
+ os << "\\fboxsep " << from_ascii(separation_string);
+ }
+ if (separation_string != defaultSep && thickness_string == defaultThick)
+ os << "{\\fboxsep " << from_ascii(separation_string);
os << "\\doublebox{";
break;
}
if (params_.inner_box) {
- if (params_.use_parbox)
+ if (params_.use_parbox) {
+ if (params_.backgroundcolor != "none" && btype == Frameless) {
+ os << maybeBeginL << "\\colorbox{" << params_.backgroundcolor << "}{";
+ needEndL = !maybeBeginL.empty();
+ }
os << "\\parbox";
- else if (params_.use_makebox) {
- os << "\\makebox";
- // FIXME UNICODE
- // output the width and horizontal position
- if (params_.special != "none") {
- os << "[" << params_.width.value()
- << '\\' << from_utf8(params_.special)
- << ']';
- } else
- os << '[' << from_ascii(width_string)
- << ']';
- if (params_.hor_pos != 'c')
- os << "[" << params_.hor_pos << "]";
+ } else if (params_.use_makebox) {
+ if (!width_string.empty()) {
+ 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") {
+ os << "[" << params_.width.value()
+ << '\\' << from_utf8(params_.special)
+ << ']';
+ } else
+ os << '[' << from_ascii(width_string)
+ << ']';
+ if (params_.hor_pos != 'c')
+ os << "[" << params_.hor_pos << "]";
+ } else {
+ if (params_.backgroundcolor != "none") {
+ os << maybeBeginL << "\\colorbox{" << params_.backgroundcolor << "}";
+ needEndL = !maybeBeginL.empty();
+ }
+ else
+ os << "\\mbox";
+ }
os << "{";
}
- else
+ else {
+ if (params_.backgroundcolor != "none" && btype == Frameless) {
+ os << maybeBeginL << "\\colorbox{" << params_.backgroundcolor << "}{";
+ needEndL = !maybeBeginL.empty();
+ }
os << "\\begin{minipage}";
+ }
// output parameters for parbox and minipage
if (!params_.use_makebox) {
}
os << "%\n";
- ++i;
} // end if inner_box
if (btype == Shaded) {
os << "\\begin{shaded}%\n";
- ++i;
}
- i += InsetText::latex(os, runparams);
+ InsetText::latex(os, runparams);
if (btype == Shaded)
os << "\\end{shaded}";
os << "%\n}";
else
os << "%\n\\end{minipage}";
+ if (params_.backgroundcolor != "none" && btype == Frameless
+ && !(params_.use_makebox && width_string.empty()))
+ os << "}";
}
switch (btype) {
break;
case Framed:
os << "\\end{framed}";
+ if (separation_string != defaultSep || thickness_string != defaultThick)
+ os << "}";
break;
case Boxed:
os << "}";
+ if (!params_.inner_box && !width_string.empty()
+ && (params_.framecolor != "black" || params_.backgroundcolor != "none"))
+ os << "}";
+ if (separation_string != defaultSep || thickness_string != defaultThick)
+ os << "}";
+ if (needendgroup)
+ os << "\\endgroup";
break;
case ovalbox:
+ os << "}";
+ if (separation_string != defaultSep)
+ os << "}";
+ break;
case Ovalbox:
+ os << "}";
+ if (separation_string != defaultSep)
+ os << "}";
+ break;
case Doublebox:
+ os << "}";
+ if (separation_string != defaultSep || thickness_string != defaultThick)
+ os << "}";
+ break;
case Shadowbox:
os << "}";
+ if (separation_string != defaultSep
+ || thickness_string != defaultThick
+ || shadowsize_string != defaultShadow)
+ os << "}";
break;
case Shaded:
// already done
break;
}
-
- i += 2;
-
- return i;
+ if (needEndL)
+ os << maybeEndL;
}
-int InsetBox::plaintext(odocstream & os, OutputParams const & runparams) const
+int InsetBox::plaintext(odocstringstream & os,
+ OutputParams const & runparams, size_t max_length) const
{
BoxType const btype = boxtranslator().find(params_.type);
break;
}
- InsetText::plaintext(os, runparams);
+ InsetText::plaintext(os, runparams, max_length);
int len = 0;
switch (btype) {
}
-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 + "'";
string style;
- if (!params_.width.empty())
- style += ("width: " + params_.width.asHTMLString() + "; ");
+ if (!params_.width.empty()) {
+ string w = params_.width.asHTMLString();
+ if (w != "100%")
+ style += ("width: " + params_.width.asHTMLString() + "; ");
+ }
// The special heights don't really mean anything for us.
if (!params_.height.empty() && params_.height_special == "none")
style += ("height: " + params_.height.asHTMLString() + "; ");
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();
}
BoxType btype = boxtranslator().find(params_.type);
switch (btype) {
case Frameless:
+ if (params_.backgroundcolor != "none")
+ features.require("xcolor");
break;
case Framed:
+ features.require("calc");
features.require("framed");
break;
case Boxed:
features.require("calc");
+ if (params_.framecolor != "black" || params_.backgroundcolor != "none")
+ features.require("xcolor");
break;
case ovalbox:
case Ovalbox:
features.require("framed");
break;
}
- InsetCollapsable::validate(features);
+ InsetCollapsible::validate(features);
}
-docstring InsetBox::contextMenuName() const
+string InsetBox::contextMenuName() const
{
- return from_ascii("context-box");
+ return "context-box";
}
void InsetBox::string2params(string const & in, InsetBoxParams & params)
{
- params = InsetBoxParams(string());
if (in.empty())
return;
"Expected arg 2 to be \"Box\"\n");
}
+ params = InsetBoxParams(string());
params.read(lex);
}
hor_pos('c'),
inner_pos('t'),
height(Length("1in")),
- height_special("totalheight") // default is 1\\totalheight
+ height_special("totalheight"), // default is 1\\totalheight
+ thickness(Length(defaultThick)),
+ separation(Length(defaultSep)),
+ shadowsize(Length(defaultShadow)),
+ framecolor("black"),
+ backgroundcolor("none")
{}
os << "special \"" << special << "\"\n";
os << "height \"" << height.asString() << "\"\n";
os << "height_special \"" << height_special << "\"\n";
+ os << "thickness \"" << thickness.asString() << "\"\n";
+ os << "separation \"" << separation.asString() << "\"\n";
+ os << "shadowsize \"" << shadowsize.asString() << "\"\n";
+ os << "framecolor \"" << framecolor << "\"\n";
+ os << "backgroundcolor \"" << backgroundcolor << "\"\n";
}
lex >> "special" >> special;
lex >> "height" >> height;
lex >> "height_special" >> height_special;
+ lex >> "thickness" >> thickness;
+ lex >> "separation" >> separation;
+ lex >> "shadowsize" >> shadowsize;
+ lex >> "framecolor" >> framecolor;
+ lex >> "backgroundcolor" >> backgroundcolor;
}
projects / lyx.git / blobdiff