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"
33 using namespace lyx::support;
40 InsetMathDecoration::InsetMathDecoration(Buffer * buf, latexkeys const * key)
41 : InsetMathNest(buf, 1), key_(key)
43 // lyxerr << " creating deco " << key->name << endl;
47 Inset * InsetMathDecoration::clone() const
49 return new InsetMathDecoration(*this);
53 bool InsetMathDecoration::upper() const
55 return key_->name.substr(0, 5) != "under" && key_->name != "utilde";
59 MathClass InsetMathDecoration::mathClass() const
61 if (key_->name == "overbrace" || key_->name == "underbrace")
67 bool InsetMathDecoration::protect() const
70 key_->name == "overbrace" ||
71 key_->name == "underbrace" ||
72 key_->name == "overleftarrow" ||
73 key_->name == "overrightarrow" ||
74 key_->name == "overleftrightarrow" ||
75 key_->name == "underleftarrow" ||
76 key_->name == "underrightarrow" ||
77 key_->name == "underleftrightarrow";
81 bool InsetMathDecoration::wide() const
84 key_->name == "overline" ||
85 key_->name == "underline" ||
86 key_->name == "overbrace" ||
87 key_->name == "underbrace" ||
88 key_->name == "overleftarrow" ||
89 key_->name == "overrightarrow" ||
90 key_->name == "overleftrightarrow" ||
91 key_->name == "widehat" ||
92 key_->name == "widetilde" ||
93 key_->name == "underleftarrow" ||
94 key_->name == "underrightarrow" ||
95 key_->name == "underleftrightarrow" ||
96 key_->name == "undertilde" ||
97 key_->name == "utilde";
101 InsetMath::mode_type InsetMathDecoration::currentMode() const
103 return key_->name == "underbar" ? TEXT_MODE : MATH_MODE;
107 void InsetMathDecoration::metrics(MetricsInfo & mi, Dimension & dim) const
109 Changer dummy = mi.base.changeEnsureMath(currentMode());
111 cell(0).metrics(mi, dim);
113 dh_ = 6; //mathed_char_height(LM_TC_VAR, mi, 'I', ascent_, descent_);
114 dw_ = 6; //mathed_char_width(LM_TC_VAR, mi, 'x');
117 dy_ = -dim.asc - dh_;
126 void InsetMathDecoration::draw(PainterInfo & pi, int x, int y) const
128 Changer dummy = pi.base.changeEnsureMath(currentMode());
130 cell(0).draw(pi, x, y);
131 Dimension const & dim0 = cell(0).dimension(*pi.base.bv);
133 mathed_draw_deco(pi, x + 1, y + dy_, dim0.wid, dh_, key_->name);
135 mathed_draw_deco(pi, x + 1 + (dim0.wid - dw_) / 2,
136 y + dy_, dw_, dh_, key_->name);
140 void InsetMathDecoration::write(WriteStream & os) const
142 MathEnsurer ensurer(os);
143 if (os.fragile() && protect())
145 os << '\\' << key_->name << '{';
146 ModeSpecifier specifier(os, currentMode());
147 os << cell(0) << '}';
152 void InsetMathDecoration::normalize(NormalStream & os) const
154 os << "[deco " << key_->name << ' ' << cell(0) << ']';
158 void InsetMathDecoration::infoize(odocstream & os) const
160 os << bformat(_("Decoration: %1$s"), key_->name);
166 Attributes() : over(false) {}
167 Attributes(bool o, string const & t, string const & entity)
168 : over(o), tag(t), entity(entity) {}
174 typedef map<string, Attributes> TranslationMap;
176 void buildTranslationMap(TranslationMap & t) {
177 // the decorations we need to support are listed in lib/symbols
178 t["acute"] = Attributes(true, "´", "´");
179 t["bar"] = Attributes(true, "‾", "¯");
180 t["breve"] = Attributes(true, "˘", "˘");
181 t["check"] = Attributes(true, "ˇ", "ˇ");
182 t["ddddot"] = Attributes(true, "⃜", "⃜");
183 t["dddot"] = Attributes(true, "⃛", "⃛");
184 t["ddot"] = Attributes(true, "¨", "¨");
185 t["dot"] = Attributes(true, "˙", "˙");
186 t["grave"] = Attributes(true, "`", "`");
187 t["hat"] = Attributes(true, "ˆ", "ˆ");
188 t["mathring"] = Attributes(true, "˚", "˚");
189 t["overbrace"] = Attributes(true, "⏞", "︷");
190 t["overleftarrow"] = Attributes(true, "⟵", "⟵");
191 t["overleftrightarrow"] = Attributes(true, "⟷", "⟷");
192 t["overline"] = Attributes(true, "¯", "¯");
193 t["overrightarrow"] = Attributes(true, "⟶", "⟶");
194 t["tilde"] = Attributes(true, "˜", "˜");
195 t["underbar"] = Attributes(false, "_", "̲");
196 t["underbrace"] = Attributes(false, "⏟", "︸");
197 t["underleftarrow"] = Attributes(false, "⟵", "⟵");
198 t["underleftrightarrow"] = Attributes(false, "⟷", "⟷");
199 // this is the macron, again, but it works
200 t["underline"] = Attributes(false, "¯", "¯");
201 t["underrightarrow"] = Attributes(false, "⟶", "⟶");
202 t["undertilde"] = Attributes(false, "∼", "∼");
203 t["utilde"] = Attributes(false, "∼", "∼");
204 t["vec"] = Attributes(true, "→", "→");
205 t["widehat"] = Attributes(true, "^", "^");
206 t["widetilde"] = Attributes(true, "∼", "∼");
209 TranslationMap const & translationMap() {
210 static TranslationMap t;
212 buildTranslationMap(t);
217 void InsetMathDecoration::mathmlize(MathStream & ms) const
219 TranslationMap const & t = translationMap();
220 TranslationMap::const_iterator cur = t.find(to_utf8(key_->name));
221 LASSERT(cur != t.end(), return);
222 char const * const outag = cur->second.over ? "mover" : "munder";
223 std::string decoration = ms.xmlMode() ? cur->second.entity : cur->second.tag;
225 << MTag("mrow") << cell(0) << ETag("mrow")
226 << "<" << from_ascii(ms.namespacedTag("mo")) << " stretchy=\"true\">"
227 << from_ascii(decoration)
228 << "</" << from_ascii(ms.namespacedTag("mo")) << ">"
233 void InsetMathDecoration::htmlize(HtmlStream & os) const
235 string const name = to_utf8(key_->name);
237 os << MTag("span", "class='overbar'") << cell(0) << ETag("span");
241 if (name == "underbar" || name == "underline") {
242 os << MTag("span", "class='underbar'") << cell(0) << ETag("span");
246 TranslationMap const & t = translationMap();
247 TranslationMap::const_iterator cur = t.find(name);
248 LASSERT(cur != t.end(), return);
250 bool symontop = cur->second.over;
251 string const symclass = symontop ? "symontop" : "symonbot";
252 os << MTag("span", "class='symbolpair " + symclass + "'")
256 os << MTag("span", "class='symbol'") << from_ascii(cur->second.tag);
258 os << MTag("span", "class='base'") << cell(0);
259 os << ETag("span") << '\n';
261 os << MTag("span", "class='base'") << cell(0);
263 os << MTag("span", "class='symbol'") << from_ascii(cur->second.tag);
264 os << ETag("span") << '\n' << ETag("span") << '\n';
268 // ideas borrowed from the eLyXer code
269 void InsetMathDecoration::validate(LaTeXFeatures & features) const
271 if (features.runparams().math_flavor == OutputParams::MathAsHTML) {
272 string const name = to_utf8(key_->name);
274 features.addCSSSnippet("span.overbar{border-top: thin black solid;}");
275 } else if (name == "underbar" || name == "underline") {
276 features.addCSSSnippet("span.underbar{border-bottom: thin black solid;}");
278 features.addCSSSnippet(
279 "span.symbolpair{display: inline-block; text-align:center;}\n"
280 "span.symontop{vertical-align: top;}\n"
281 "span.symonbot{vertical-align: bottom;}\n"
282 "span.symbolpair span{display: block;}\n"
283 "span.symbol{height: 0.5ex;}");
286 if (!key_->required.empty())
287 features.require(key_->required);
289 InsetMathNest::validate(features);