2 * \file InsetMathDecoration.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Alejandro Aguilar Sierra
9 * Full author contact details are available in file CREDITS.
14 #include "InsetMathDecoration.h"
17 #include "MathParser.h"
18 #include "MathSupport.h"
19 #include "MathStream.h"
20 #include "MetricsInfo.h"
22 #include "LaTeXFeatures.h"
24 #include "support/debug.h"
25 #include "support/docstring.h"
26 #include "support/gettext.h"
27 #include "support/lassert.h"
28 #include "support/lstrings.h"
32 using namespace lyx::support;
39 InsetMathDecoration::InsetMathDecoration(Buffer * buf, latexkeys const * key)
40 : InsetMathNest(buf, 1), key_(key), dh_(0), dy_(0), dw_(0)
42 // lyxerr << " creating deco " << key->name << endl;
46 Inset * InsetMathDecoration::clone() const
48 return new InsetMathDecoration(*this);
52 bool InsetMathDecoration::upper() const
54 return key_->name.substr(0, 5) != "under" && key_->name != "utilde";
58 bool InsetMathDecoration::isScriptable() const
61 key_->name == "overbrace" ||
62 key_->name == "underbrace";
66 bool InsetMathDecoration::protect() const
69 key_->name == "overbrace" ||
70 key_->name == "underbrace" ||
71 key_->name == "overleftarrow" ||
72 key_->name == "overrightarrow" ||
73 key_->name == "overleftrightarrow" ||
74 key_->name == "underleftarrow" ||
75 key_->name == "underrightarrow" ||
76 key_->name == "underleftrightarrow";
80 bool InsetMathDecoration::wide() const
83 key_->name == "overline" ||
84 key_->name == "underline" ||
85 key_->name == "overbrace" ||
86 key_->name == "underbrace" ||
87 key_->name == "overleftarrow" ||
88 key_->name == "overrightarrow" ||
89 key_->name == "overleftrightarrow" ||
90 key_->name == "widehat" ||
91 key_->name == "widetilde" ||
92 key_->name == "underleftarrow" ||
93 key_->name == "underrightarrow" ||
94 key_->name == "underleftrightarrow" ||
95 key_->name == "undertilde" ||
96 key_->name == "utilde";
100 InsetMath::mode_type InsetMathDecoration::currentMode() const
102 return key_->name == "underbar" ? TEXT_MODE : MATH_MODE;
106 void InsetMathDecoration::metrics(MetricsInfo & mi, Dimension & dim) const
109 (currentMode() == MATH_MODE) ? mi.base.changeEnsureMath() :
110 (isMathFont(mi.base.fontname)) ? mi.base.changeFontSet("textnormal")
113 cell(0).metrics(mi, dim);
115 dh_ = 6; //mathed_char_height(LM_TC_VAR, mi, 'I', ascent_, descent_);
116 dw_ = 6; //mathed_char_width(LM_TC_VAR, mi, 'x');
119 dy_ = -dim.asc - dh_;
126 metricsMarkers(mi, dim);
130 void InsetMathDecoration::draw(PainterInfo & pi, int x, int y) const
133 (currentMode() == MATH_MODE) ? pi.base.changeEnsureMath() :
134 (isMathFont(pi.base.fontname)) ? pi.base.changeFontSet("textnormal")
137 cell(0).draw(pi, x + 1, y);
138 Dimension const & dim0 = cell(0).dimension(*pi.base.bv);
140 mathed_draw_deco(pi, x + 1, y + dy_, dim0.wid, dh_, key_->name);
142 mathed_draw_deco(pi, x + 1 + (dim0.wid - dw_) / 2,
143 y + dy_, dw_, dh_, key_->name);
144 drawMarkers(pi, x, y);
148 void InsetMathDecoration::write(WriteStream & os) const
150 MathEnsurer ensurer(os);
151 if (os.fragile() && protect())
153 os << '\\' << key_->name << '{';
154 ModeSpecifier specifier(os, currentMode());
155 os << cell(0) << '}';
159 void InsetMathDecoration::normalize(NormalStream & os) const
161 os << "[deco " << key_->name << ' ' << cell(0) << ']';
165 void InsetMathDecoration::infoize(odocstream & os) const
167 os << bformat(_("Decoration: %1$s"), key_->name);
173 Attributes() : over(false) {}
174 Attributes(bool o, string t)
180 typedef map<string, Attributes> TranslationMap;
182 void buildTranslationMap(TranslationMap & t) {
183 // the decorations we need to support are listed in lib/symbols
184 t["acute"] = Attributes(true, "´");
185 t["bar"] = Attributes(true, "‾");
186 t["breve"] = Attributes(true, "˘");
187 t["check"] = Attributes(true, "ˇ");
188 t["ddddot"] = Attributes(true, "⃜");
189 t["dddot"] = Attributes(true, "⃛");
190 t["ddot"] = Attributes(true, "¨");
191 t["dot"] = Attributes(true, "˙");
192 t["grave"] = Attributes(true, "`");
193 t["hat"] = Attributes(true, "ˆ");
194 t["mathring"] = Attributes(true, "˚");
195 t["overbrace"] = Attributes(true, "⏞");
196 t["overleftarrow"] = Attributes(true, "⟵");
197 t["overleftrightarrow"] = Attributes(true, "⟷");
198 t["overline"] = Attributes(true, "¯");
199 t["overrightarrow"] = Attributes(true, "⟶");
200 t["tilde"] = Attributes(true, "˜");
201 t["underbar"] = Attributes(false, "_");
202 t["underbrace"] = Attributes(false, "⏟");
203 t["underleftarrow"] = Attributes(false, "⟵");
204 t["underleftrightarrow"] = Attributes(false, "⟷");
205 // this is the macron, again, but it works
206 t["underline"] = Attributes(false, "¯");
207 t["underrightarrow"] = Attributes(false, "⟶");
208 t["undertilde"] = Attributes(false, "∼");
209 t["utilde"] = Attributes(false, "∼");
210 t["vec"] = Attributes(true, "→");
211 t["widehat"] = Attributes(true, "^");
212 t["widetilde"] = Attributes(true, "∼");
215 TranslationMap const & translationMap() {
216 static TranslationMap t;
218 buildTranslationMap(t);
223 void InsetMathDecoration::mathmlize(MathStream & os) const
225 TranslationMap const & t = translationMap();
226 TranslationMap::const_iterator cur = t.find(to_utf8(key_->name));
227 LASSERT(cur != t.end(), return);
228 char const * const outag = cur->second.over ? "mover" : "munder";
230 << MTag("mrow") << cell(0) << ETag("mrow")
231 << from_ascii("<mo stretchy=\"true\">" + cur->second.tag + "</mo>")
236 void InsetMathDecoration::htmlize(HtmlStream & os) const
238 string const name = to_utf8(key_->name);
240 os << MTag("span", "class='overbar'") << cell(0) << ETag("span");
244 if (name == "underbar" || name == "underline") {
245 os << MTag("span", "class='underbar'") << cell(0) << ETag("span");
249 TranslationMap const & t = translationMap();
250 TranslationMap::const_iterator cur = t.find(name);
251 LASSERT(cur != t.end(), return);
253 bool symontop = cur->second.over;
254 string const symclass = symontop ? "symontop" : "symonbot";
255 os << MTag("span", "class='symbolpair " + symclass + "'")
259 os << MTag("span", "class='symbol'") << from_ascii(cur->second.tag);
261 os << MTag("span", "class='base'") << cell(0);
262 os << ETag("span") << '\n';
264 os << MTag("span", "class='base'") << cell(0);
266 os << MTag("span", "class='symbol'") << from_ascii(cur->second.tag);
267 os << ETag("span") << '\n' << ETag("span") << '\n';
271 // ideas borrowed from the eLyXer code
272 void InsetMathDecoration::validate(LaTeXFeatures & features) const
274 if (features.runparams().math_flavor == OutputParams::MathAsHTML) {
275 string const name = to_utf8(key_->name);
277 features.addCSSSnippet("span.overbar{border-top: thin black solid;}");
278 } else if (name == "underbar" || name == "underline") {
279 features.addCSSSnippet("span.underbar{border-bottom: thin black solid;}");
281 features.addCSSSnippet(
282 "span.symbolpair{display: inline-block; text-align:center;}\n"
283 "span.symontop{vertical-align: top;}\n"
284 "span.symonbot{vertical-align: bottom;}\n"
285 "span.symbolpair span{display: block;}\n"
286 "span.symbol{height: 0.5ex;}");
289 if (!key_->requires.empty())
290 features.require(key_->requires);
292 InsetMathNest::validate(features);