2 * \file InsetMathChar.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 "InsetMathChar.h"
16 #include "MathParser.h"
17 #include "MathSupport.h"
18 #include "MathStream.h"
19 #include "MetricsInfo.h"
21 #include "Dimension.h"
22 #include "BufferEncodings.h"
23 #include "LaTeXFeatures.h"
24 #include "TextPainter.h"
26 #include "frontends/FontMetrics.h"
28 #include "support/debug.h"
29 #include "support/lstrings.h"
30 #include "support/textutils.h"
39 extern bool has_math_fonts;
43 latexkeys const * makeSubstitute(char_type c)
47 // Latex replaces ', *, -, and : with specific symbols. With unicode-math,
48 // these symbols are replaced respectively by ^U+2032, U+2217, U+2212 and
49 // U+2236 (the latter substitution can be turned off with a package
50 // option). Unicode-math also replaces ` with \backprime.
51 // prime needs to be placed in superscript unless an opentype font is used.
59 name = "lyxminus";// unicode-math: "minus"
62 name = "ordinarycolon";// unicode-math: "mathratio"
64 // The remaining replacements are not real character substitutions (from a
65 // unicode point of view) but are done here: 1. for cosmetic reasons, in the
66 // context of being stuck with CM fonts at the moment, to ensure consistency
67 // with related symbols: -, \leq, \geq, etc. 2. to get the proper spacing
68 // as defined in lib/symbols.
70 name = "lyxplus";//unicode-math: "mathplus"
73 name = "lyxgt";//unicode-math: "greater"
76 name = "lyxlt";//unicode-math: "less"
79 name = "lyxeqrel";//unicode-math: "equal"
81 //case ','://unicode-math: "mathcomma"
82 //case ';'://unicode-math: "mathsemicolon"
86 return in_word_set(from_ascii(name));
89 } //anonymous namespace
92 static bool slanted(char_type c)
94 return isAlphaASCII(c) || Encodings::isMathAlpha(c);
98 InsetMathChar::InsetMathChar(char_type c)
99 : char_(c), kerning_(0), subst_(makeSubstitute(c))
104 Inset * InsetMathChar::clone() const
106 return new InsetMathChar(*this);
110 void InsetMathChar::metrics(MetricsInfo & mi, Dimension & dim) const
112 string const & f = mi.base.fontname;
113 if (isMathFont(f) && subst_) {
114 // If the char has a substitute, draw the replacement symbol
115 // instead, but only in math mode.
116 kerning_ = mathedSymbolDim(mi.base, dim, subst_);
117 } else if (!slanted(char_) && f == "mathnormal") {
118 Changer dummy = mi.base.font.changeShape(UP_SHAPE);
119 dim = theFontMetrics(mi.base.font).dimension(char_);
121 } else if (!isASCII(char_) && Encodings::unicodeCharInfo(char_).isUnicodeSymbol()) {
122 Changer dummy1 = mi.base.changeFontSet("mathnormal");
123 Changer dummy2 = Encodings::isMathAlpha(char_)
125 : mi.base.font.changeShape(UP_SHAPE);
126 dim = theFontMetrics(mi.base.font).dimension(char_);
127 kerning_ = -mathed_char_kerning(mi.base.font, char_);
129 frontend::FontMetrics const & fm = theFontMetrics(mi.base.font);
130 dim = fm.dimension(char_);
131 kerning_ = mathed_char_kerning(mi.base.font, char_);
132 // cmmi has almost no left bearing: simulate this
133 if (f == "mathnormal") {
134 dim.wid += max(-fm.lbearing(char_), 0);
136 // Rule 17 from Appendix G
137 // These are the fonts with fontdimen(2)==0.
138 // To properly handle the case fontdimen(2)!=0 (that is for all other
139 // math fonts), where the italic correction must also be converted into
140 // kerning but only at the end of strings of characters with the same
141 // font, one would need a more elaborate implementation in MathRow. For
142 // now the case fontdimen(2)==0 is the most important.
143 if (f == "mathnormal" || f == "mathscr" || f == "mathcal") {
145 // We use a negative value to tell InsetMathScript to move the
146 // subscript leftwards instead of the superscript rightwards
147 kerning_ = -kerning_;
153 void InsetMathChar::draw(PainterInfo & pi, int x, int y) const
155 //lyxerr << "drawing '" << char_ << "' font: " << pi.base.fontname << std::endl;
156 if (isMathFont(pi.base.fontname)) {
158 // If the char has a substitute, draw the replacement symbol
159 // instead, but only in math mode.
160 mathedSymbolDraw(pi, x, y, subst_);
162 } else if (!slanted(char_) && pi.base.fontname == "mathnormal") {
163 Changer dummy = pi.base.font.changeShape(UP_SHAPE);
164 pi.draw(x, y, char_);
166 } else if (!isASCII(char_) && Encodings::unicodeCharInfo(char_).isUnicodeSymbol()) {
167 Changer dummy1 = pi.base.changeFontSet("mathnormal");
168 Changer dummy2 = Encodings::isMathAlpha(char_)
170 : pi.base.font.changeShape(UP_SHAPE);
171 pi.draw(x, y, char_);
175 // cmmi has almost no left bearing: simulate this
176 if (pi.base.fontname == "mathnormal") {
177 x += max(-theFontMetrics(pi.base.font).lbearing(char_), 0);
179 pi.draw(x, y, char_);
183 void InsetMathChar::metricsT(TextMetricsInfo const &, Dimension & dim) const
191 void InsetMathChar::drawT(TextPainter & pain, int x, int y) const
193 //lyxerr << "drawing text '" << char_ << "' code: " << code_ << endl;
194 pain.draw(x, y, char_);
198 void InsetMathChar::write(TeXMathStream & os) const
204 void InsetMathChar::validate(LaTeXFeatures & features) const
207 BufferEncodings::validate(char_, features, true);
211 void InsetMathChar::normalize(NormalStream & os) const
219 void InsetMathChar::octave(OctaveStream & os) const
225 // We have a bit of a problem here. MathML wants to know whether the
226 // character represents an "identifier" or an "operator", and we have
227 // no general way of telling. So we shall guess: If it's alpha or
228 // mathalpha, then we'll treat it as an identifier, otherwise as an
230 // Worst case: We get bad spacing, or bad italics.
231 void InsetMathChar::mathmlize(MathMLStream & ms) const
235 case '<': entity = "<"; break;
236 case '>': entity = ">"; break;
237 case '&': entity = "&"; break;
240 ms << from_ascii(" ");
242 ms << from_ascii(" ");
252 ms << from_ascii(entity);
256 if (!entity.empty()) {
257 ms << "<" << from_ascii(ms.namespacedTag("mo")) << ">"
258 << from_ascii(entity)
259 << "</" << from_ascii(ms.namespacedTag("mo")) << ">";
264 (isAlphaASCII(char_) || Encodings::isMathAlpha(char_))
266 // we don't use MTag and ETag because we do not want the spacing before the end tag.
267 docstring tag = from_ascii(ms.namespacedTag(type));
268 ms << "<" << tag << ">" << char_type(char_) << "</" << tag << ">";
272 void InsetMathChar::htmlize(HtmlStream & ms) const
275 // Not taking subst_ into account here because the MathML output of
276 // <>=+-* looks correct as it is. FIXME: ' is not output as ^\prime
278 case '<': entity = "<"; break;
279 case '>': entity = ">"; break;
280 case '&': entity = "&"; break;
281 case ' ': entity = " "; break;
285 bool have_entity = !entity.empty();
289 ms << from_ascii(entity);
296 // an operator, so give some space
297 ms << ' ' << from_ascii(entity) << ' ';
301 if (isAlphaASCII(char_) || Encodings::isMathAlpha(char_))
302 // we don't use MTag and ETag because we do not want the spacing
303 ms << MTag("i") << char_type(char_) << ETag("i");
305 // an operator, so give some space
306 ms << " " << char_type(char_) << " ";
310 MathClass InsetMathChar::mathClass() const
312 // this information comes from fontmath.ltx in LaTeX source.
313 char const ch = static_cast<char>(char_);
315 return string_to_class(subst_->extra);
316 else if (support::contains(",;", ch))
318 else if (support::contains("([", ch))
320 else if (support::contains(")]!?", ch))