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/lassert.h"
35 InsetMathDecoration::InsetMathDecoration(Buffer * buf, latexkeys const * key)
36 : InsetMathNest(buf, 1), key_(key)
38 // lyxerr << " creating deco " << key->name << endl;
42 Inset * InsetMathDecoration::clone() const
44 return new InsetMathDecoration(*this);
48 bool InsetMathDecoration::upper() const
50 return key_->name.substr(0, 5) != "under" && key_->name != "utilde";
54 bool InsetMathDecoration::isScriptable() const
57 key_->name == "overbrace" ||
58 key_->name == "underbrace" ||
59 key_->name == "overleftarrow" ||
60 key_->name == "overrightarrow" ||
61 key_->name == "overleftrightarrow" ||
62 key_->name == "underleftarrow" ||
63 key_->name == "underrightarrow" ||
64 key_->name == "underleftrightarrow";
68 bool InsetMathDecoration::protect() const
71 key_->name == "overbrace" ||
72 key_->name == "underbrace" ||
73 key_->name == "overleftarrow" ||
74 key_->name == "overrightarrow" ||
75 key_->name == "overleftrightarrow" ||
76 key_->name == "underleftarrow" ||
77 key_->name == "underrightarrow" ||
78 key_->name == "underleftrightarrow";
82 bool InsetMathDecoration::wide() const
85 key_->name == "overline" ||
86 key_->name == "underline" ||
87 key_->name == "overbrace" ||
88 key_->name == "underbrace" ||
89 key_->name == "overleftarrow" ||
90 key_->name == "overrightarrow" ||
91 key_->name == "overleftrightarrow" ||
92 key_->name == "widehat" ||
93 key_->name == "widetilde" ||
94 key_->name == "underleftarrow" ||
95 key_->name == "underrightarrow" ||
96 key_->name == "underleftrightarrow" ||
97 key_->name == "undertilde" ||
98 key_->name == "utilde";
102 InsetMath::mode_type InsetMathDecoration::currentMode() const
104 return key_->name == "underbar" ? TEXT_MODE : MATH_MODE;
108 void InsetMathDecoration::metrics(MetricsInfo & mi, Dimension & dim) const
110 bool really_change_font = currentMode() == TEXT_MODE
111 && isMathFont(from_ascii(mi.base.fontname));
112 FontSetChanger dummy(mi.base, "textnormal", really_change_font);
114 cell(0).metrics(mi, dim);
116 dh_ = 6; //mathed_char_height(LM_TC_VAR, mi, 'I', ascent_, descent_);
117 dw_ = 6; //mathed_char_width(LM_TC_VAR, mi, 'x');
120 dy_ = -dim.asc - dh_;
131 void InsetMathDecoration::draw(PainterInfo & pi, int x, int y) const
133 bool really_change_font = currentMode() == TEXT_MODE
134 && isMathFont(from_ascii(pi.base.fontname));
135 FontSetChanger dummy(pi.base, "textnormal", really_change_font);
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);
145 setPosCache(pi, x, y);
149 void InsetMathDecoration::write(WriteStream & os) const
151 MathEnsurer ensurer(os);
152 if (os.fragile() && protect())
154 os << '\\' << key_->name << '{';
155 ModeSpecifier specifier(os, currentMode());
156 os << cell(0) << '}';
160 void InsetMathDecoration::normalize(NormalStream & os) const
162 os << "[deco " << key_->name << ' ' << cell(0) << ']';
166 void InsetMathDecoration::infoize(odocstream & os) const
168 os << "Deco: " << key_->name;
175 Attributes(bool o, string t)
181 typedef map<string, Attributes> TranslationMap;
183 void buildTranslationMap(TranslationMap & t) {
184 // the decorations we need to support are listed in lib/symbols
185 t["acute"] = Attributes(true, "´");
186 t["bar"] = Attributes(true, "‾");
187 t["breve"] = Attributes(true, "˘");
188 t["check"] = Attributes(true, "ˇ");
189 t["ddddot"] = Attributes(true, "⃜");
190 t["dddot"] = Attributes(true, "⃛");
191 t["ddot"] = Attributes(true, "¨");
192 t["dot"] = Attributes(true, "˙");
193 t["grave"] = Attributes(true, "`");
194 t["hat"] = Attributes(true, "ˆ");
195 t["mathring"] = Attributes(true, "˚");
196 t["overbrace"] = Attributes(true, "⏞");
197 t["overleftarrow"] = Attributes(true, "⟵");
198 t["overleftrightarrow"] = Attributes(true, "⟷");
199 t["overline"] = Attributes(true, "¯");
200 t["overrightarrow"] = Attributes(true, "⟶");
201 t["tilde"] = Attributes(true, "˜");
202 t["underbar"] = Attributes(false, "_");
203 t["underbrace"] = Attributes(false, "⏟");
204 t["underleftarrow"] = Attributes(false, "⟵");
205 t["underleftrightarrow"] = Attributes(false, "⟷");
206 // this is the macron, again, but it works
207 t["underline"] = Attributes(false, "¯");
208 t["underrightarrow"] = Attributes(false, "⟶");
209 t["undertilde"] = Attributes(false, "∼");
210 t["utilde"] = Attributes(false, "∼");
211 t["vec"] = Attributes(true, "→");
212 t["widehat"] = Attributes(true, "^");
213 t["widetilde"] = Attributes(true, "∼");
216 TranslationMap const & translationMap() {
217 static TranslationMap t;
219 buildTranslationMap(t);
224 void InsetMathDecoration::mathmlize(MathStream & os) const
226 TranslationMap const & t = translationMap();
227 TranslationMap::const_iterator cur = t.find(to_utf8(key_->name));
228 LASSERT(cur != t.end(), return);
229 char const * const outag = cur->second.over ? "mover" : "munder";
231 << MTag("mrow") << cell(0) << ETag("mrow")
232 << from_ascii("<mo stretchy=\"true\">" + cur->second.tag + "</mo>")
237 void InsetMathDecoration::htmlize(HtmlStream & os) const
239 string const name = to_utf8(key_->name);
241 os << MTag("span", "class='overbar'") << cell(0) << ETag("span");
245 if (name == "underbar" || name == "underline") {
246 os << MTag("span", "class='underbar'") << cell(0) << ETag("span");
250 TranslationMap const & t = translationMap();
251 TranslationMap::const_iterator cur = t.find(name);
252 LASSERT(cur != t.end(), return);
254 bool symontop = cur->second.over;
255 string const symclass = symontop ? "symontop" : "symonbot";
256 os << MTag("span", "class='symbolpair " + symclass + "'")
260 os << MTag("span", "class='symbol'") << from_ascii(cur->second.tag);
262 os << MTag("span", "class='base'") << cell(0);
263 os << ETag("span") << '\n';
265 os << MTag("span", "class='base'") << cell(0);
267 os << MTag("span", "class='symbol'") << from_ascii(cur->second.tag);
268 os << ETag("span") << '\n' << ETag("span") << '\n';
272 // ideas borrowed from the eLyXer code
273 void InsetMathDecoration::validate(LaTeXFeatures & features) const
275 if (features.runparams().math_flavor == OutputParams::MathAsHTML) {
276 string const name = to_utf8(key_->name);
278 features.addPreambleSnippet("<style type=\"text/css\">\n"
279 "span.overbar{border-top: thin black solid;}\n"
281 } else if (name == "underbar" || name == "underline") {
282 features.addPreambleSnippet("<style type=\"text/css\">\n"
283 "span.underbar{border-bottom: thin black solid;}\n"
286 features.addPreambleSnippet("<style type=\"text/css\">\n"
287 "span.symbolpair{display: inline-block; text-align:center;}\n"
288 "span.symontop{vertical-align: top;}\n"
289 "span.symonbot{vertical-align: bottom;}\n"
290 "span.symbolpair span{display: block;}\n"
291 "span.symbol{height: 0.5ex;}\n"
295 if (!key_->requires.empty())
296 features.require(to_utf8(key_->requires));
298 InsetMathNest::validate(features);