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
108 bool really_change_font = currentMode() == TEXT_MODE
109 && isMathFont(mi.base.fontname);
110 Changer dummy = mi.base.changeFontSet("textnormal", really_change_font);
112 cell(0).metrics(mi, dim);
114 dh_ = 6; //mathed_char_height(LM_TC_VAR, mi, 'I', ascent_, descent_);
115 dw_ = 6; //mathed_char_width(LM_TC_VAR, mi, 'x');
118 dy_ = -dim.asc - dh_;
125 metricsMarkers(mi, dim);
129 void InsetMathDecoration::draw(PainterInfo & pi, int x, int y) const
131 bool really_change_font = currentMode() == TEXT_MODE
132 && isMathFont(pi.base.fontname);
133 Changer dummy = pi.base.changeFontSet("textnormal", really_change_font);
135 cell(0).draw(pi, x + 1, y);
136 Dimension const & dim0 = cell(0).dimension(*pi.base.bv);
138 mathed_draw_deco(pi, x + 1, y + dy_, dim0.wid, dh_, key_->name);
140 mathed_draw_deco(pi, x + 1 + (dim0.wid - dw_) / 2,
141 y + dy_, dw_, dh_, key_->name);
142 drawMarkers(pi, x, y);
143 setPosCache(pi, x, y);
147 void InsetMathDecoration::write(WriteStream & os) const
149 MathEnsurer ensurer(os);
150 if (os.fragile() && protect())
152 os << '\\' << key_->name << '{';
153 ModeSpecifier specifier(os, currentMode());
154 os << cell(0) << '}';
158 void InsetMathDecoration::normalize(NormalStream & os) const
160 os << "[deco " << key_->name << ' ' << cell(0) << ']';
164 void InsetMathDecoration::infoize(odocstream & os) const
166 os << bformat(_("Decoration: %1$s"), key_->name);
172 Attributes() : over(false) {}
173 Attributes(bool o, string t)
179 typedef map<string, Attributes> TranslationMap;
181 void buildTranslationMap(TranslationMap & t) {
182 // the decorations we need to support are listed in lib/symbols
183 t["acute"] = Attributes(true, "´");
184 t["bar"] = Attributes(true, "‾");
185 t["breve"] = Attributes(true, "˘");
186 t["check"] = Attributes(true, "ˇ");
187 t["ddddot"] = Attributes(true, "⃜");
188 t["dddot"] = Attributes(true, "⃛");
189 t["ddot"] = Attributes(true, "¨");
190 t["dot"] = Attributes(true, "˙");
191 t["grave"] = Attributes(true, "`");
192 t["hat"] = Attributes(true, "ˆ");
193 t["mathring"] = Attributes(true, "˚");
194 t["overbrace"] = Attributes(true, "⏞");
195 t["overleftarrow"] = Attributes(true, "⟵");
196 t["overleftrightarrow"] = Attributes(true, "⟷");
197 t["overline"] = Attributes(true, "¯");
198 t["overrightarrow"] = Attributes(true, "⟶");
199 t["tilde"] = Attributes(true, "˜");
200 t["underbar"] = Attributes(false, "_");
201 t["underbrace"] = Attributes(false, "⏟");
202 t["underleftarrow"] = Attributes(false, "⟵");
203 t["underleftrightarrow"] = Attributes(false, "⟷");
204 // this is the macron, again, but it works
205 t["underline"] = Attributes(false, "¯");
206 t["underrightarrow"] = Attributes(false, "⟶");
207 t["undertilde"] = Attributes(false, "∼");
208 t["utilde"] = Attributes(false, "∼");
209 t["vec"] = Attributes(true, "→");
210 t["widehat"] = Attributes(true, "^");
211 t["widetilde"] = Attributes(true, "∼");
214 TranslationMap const & translationMap() {
215 static TranslationMap t;
217 buildTranslationMap(t);
222 void InsetMathDecoration::mathmlize(MathStream & os) const
224 TranslationMap const & t = translationMap();
225 TranslationMap::const_iterator cur = t.find(to_utf8(key_->name));
226 LASSERT(cur != t.end(), return);
227 char const * const outag = cur->second.over ? "mover" : "munder";
229 << MTag("mrow") << cell(0) << ETag("mrow")
230 << from_ascii("<mo stretchy=\"true\">" + cur->second.tag + "</mo>")
235 void InsetMathDecoration::htmlize(HtmlStream & os) const
237 string const name = to_utf8(key_->name);
239 os << MTag("span", "class='overbar'") << cell(0) << ETag("span");
243 if (name == "underbar" || name == "underline") {
244 os << MTag("span", "class='underbar'") << cell(0) << ETag("span");
248 TranslationMap const & t = translationMap();
249 TranslationMap::const_iterator cur = t.find(name);
250 LASSERT(cur != t.end(), return);
252 bool symontop = cur->second.over;
253 string const symclass = symontop ? "symontop" : "symonbot";
254 os << MTag("span", "class='symbolpair " + symclass + "'")
258 os << MTag("span", "class='symbol'") << from_ascii(cur->second.tag);
260 os << MTag("span", "class='base'") << cell(0);
261 os << ETag("span") << '\n';
263 os << MTag("span", "class='base'") << cell(0);
265 os << MTag("span", "class='symbol'") << from_ascii(cur->second.tag);
266 os << ETag("span") << '\n' << ETag("span") << '\n';
270 // ideas borrowed from the eLyXer code
271 void InsetMathDecoration::validate(LaTeXFeatures & features) const
273 if (features.runparams().math_flavor == OutputParams::MathAsHTML) {
274 string const name = to_utf8(key_->name);
276 features.addCSSSnippet("span.overbar{border-top: thin black solid;}");
277 } else if (name == "underbar" || name == "underline") {
278 features.addCSSSnippet("span.underbar{border-bottom: thin black solid;}");
280 features.addCSSSnippet(
281 "span.symbolpair{display: inline-block; text-align:center;}\n"
282 "span.symontop{vertical-align: top;}\n"
283 "span.symonbot{vertical-align: bottom;}\n"
284 "span.symbolpair span{display: block;}\n"
285 "span.symbol{height: 0.5ex;}");
288 if (!key_->requires.empty())
289 features.require(key_->requires);
291 InsetMathNest::validate(features);