]> git.lyx.org Git - lyx.git/blobdiff - src/mathed/InsetMathChar.cpp
Display properly math characters that behave like symbols
[lyx.git] / src / mathed / InsetMathChar.cpp
index 46083a439eebb75bce0fbaadab1b79a290641add..ae843bf00dd6c9e5f66215b44e0d67a2096b533c 100644 (file)
@@ -4,7 +4,7 @@
  * Licence details can be found in the file COPYING.
  *
  * \author Alejandro Aguilar Sierra
- * \author André Pönitz
+ * \author André Pönitz
  *
  * Full author contact details are available in file CREDITS.
  */
 
 #include "InsetMathChar.h"
 
+#include "MathParser.h"
 #include "MathSupport.h"
 #include "MathStream.h"
 #include "MetricsInfo.h"
 
 #include "Dimension.h"
+#include "BufferEncodings.h"
+#include "LaTeXFeatures.h"
 #include "TextPainter.h"
 
 #include "frontends/FontMetrics.h"
 
 #include "support/debug.h"
 #include "support/lstrings.h"
+#include "support/textutils.h"
 
 
 namespace lyx {
@@ -31,20 +35,65 @@ namespace lyx {
 extern bool has_math_fonts;
 
 
-static bool isBinaryOp(char_type c)
+namespace {
+
+latexkeys const * makeSubstitute(char_type c)
 {
-       return support::contains("+-<>=/*", static_cast<char>(c));
+       std::string name;
+       switch (c) {
+       // Latex replaces ', *, -, and : with specific symbols. With unicode-math,
+       // these symbols are replaced respectively by ^U+2032, U+2217, U+2212 and
+       // U+2236 (the latter substitution can be turned off with a package
+       // option). Unicode-math also replaces ` with \backprime.
+               // prime needs to be placed in superscript unless an opentype font is used.
+               //case '\'':
+               //name = "prime";
+               //break;
+       case '*':
+               name = "ast";
+               break;
+       case '-':
+               name = "lyxminus";// unicode-math: "minus"
+               break;
+       case ':':
+               name = "ordinarycolon";// unicode-math: "mathratio"
+               break;
+       // The remaining replacements are not real character substitutions (from a
+       // unicode point of view) but are done here: 1. for cosmetic reasons, in the
+       // context of being stuck with CM fonts at the moment, to ensure consistency
+       // with related symbols: -, \leq, \geq, etc.  2. to get the proper spacing
+       // as defined in lib/symbols.
+       case '+':
+               name = "lyxplus";//unicode-math: "mathplus"
+               break;
+       case '>':
+               name = "lyxgt";//unicode-math: "greater"
+               break;
+       case '<':
+               name = "lyxlt";//unicode-math: "less"
+               break;
+       case '=':
+               name = "lyxeqrel";//unicode-math: "equal"
+               break;
+       //case ','://unicode-math: "mathcomma"
+       //case ';'://unicode-math: "mathsemicolon"
+       default:
+               return nullptr;
+       }
+       return in_word_set(from_ascii(name));
 }
 
+} //anonymous namespace
+
 
 static bool slanted(char_type c)
 {
-       return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
+       return isAlphaASCII(c) || Encodings::isMathAlpha(c);
 }
 
 
 InsetMathChar::InsetMathChar(char_type c)
-       : char_(c), kerning_(0)
+       : char_(c), kerning_(0), subst_(makeSubstitute(c))
 {}
 
 
@@ -57,60 +106,42 @@ Inset * InsetMathChar::clone() const
 
 void InsetMathChar::metrics(MetricsInfo & mi, Dimension & dim) const
 {
-#if 1
-       if (char_ == '=' && has_math_fonts) {
-               FontSetChanger dummy(mi.base, "cmr");
-               dim = theFontMetrics(mi.base.font).dimension(char_);
-       } else if ((char_ == '>' || char_ == '<') && has_math_fonts) {
-               FontSetChanger dummy(mi.base, "cmm");
-               dim = theFontMetrics(mi.base.font).dimension(char_);
+       bool const mathfont = isMathFont(mi.base.fontname);
+       if (mathfont && subst_) {
+               // If the char has a substitute, draw the replacement symbol
+               // instead, but only in math mode.
+               mathedSymbolDim(mi, dim, subst_);
+               kerning_ = mathed_char_kerning(mi.base.font, *subst_->draw.rbegin());
+               return;
        } else if (!slanted(char_) && mi.base.fontname == "mathnormal") {
-               ShapeChanger dummy(mi.base.font, UP_SHAPE);
+               Changer dummy = mi.base.font.changeShape(UP_SHAPE);
                dim = theFontMetrics(mi.base.font).dimension(char_);
        } else {
                frontend::FontMetrics const & fm = theFontMetrics(mi.base.font);
                dim = fm.dimension(char_);
                kerning_ = fm.rbearing(char_) - dim.wid;
        }
-       int const em = mathed_char_width(mi.base.font, 'M');
-       if (isBinaryOp(char_))
-               dim.wid += static_cast<int>(0.5*em+0.5);
-       else if (char_ == '\'')
-               dim.wid += static_cast<int>(0.1667*em+0.5);
-#else
-       whichFont(font_, code_, mi);
-       dim = theFontMetrics(font_).dimension(char_);
-       if (isBinaryOp(char_, code_))
-               dim.wid += 2 * theFontMetrics(font_).width(' ');
-       lyxerr << "InsetMathChar::metrics: " << dim << endl;
-#endif
+       if (mathfont && isMathPunct())
+               dim.wid += mathed_thinmuskip(mi.base.font);
 }
 
 
 void InsetMathChar::draw(PainterInfo & pi, int x, int y) const
 {
-       //lyxerr << "drawing '" << char_ << "' font: " << pi.base.fontname << endl;
-       int const em = mathed_char_width(pi.base.font, 'M');
-       if (isBinaryOp(char_))
-               x += static_cast<int>(0.25*em+0.5);
-       else if (char_ == '\'')
-               x += static_cast<int>(0.0833*em+0.5);
-#if 1
-       if (char_ == '=' && has_math_fonts) {
-               FontSetChanger dummy(pi.base, "cmr");
-               pi.draw(x, y, char_);
-       } else if ((char_ == '>' || char_ == '<') && has_math_fonts) {
-               FontSetChanger dummy(pi.base, "cmm");
-               pi.draw(x, y, char_);
-       } else if (!slanted(char_) && pi.base.fontname == "mathnormal") {
-               ShapeChanger dummy(pi.base.font, UP_SHAPE);
-               pi.draw(x, y, char_);
-       } else {
-               pi.draw(x, y, char_);
+       //lyxerr << "drawing '" << char_ << "' font: " << pi.base.fontname << std::endl;
+       if (isMathFont(pi.base.fontname)) {
+               if (subst_) {
+                       // If the char has a substitute, draw the replacement symbol
+                       // instead, but only in math mode.
+                       mathedSymbolDraw(pi, x, y, subst_);
+                       return;
+               } else if (!slanted(char_) && pi.base.fontname == "mathnormal") {
+                       Changer dummy = pi.base.font.changeShape(UP_SHAPE);
+                       pi.draw(x, y, char_);
+                       return;
+               }
        }
-#else
-       drawChar(pain, font_, x, y, char_);
-#endif
+       pi.draw(x, y, char_);
 }
 
 
@@ -135,6 +166,13 @@ void InsetMathChar::write(WriteStream & os) const
 }
 
 
+void InsetMathChar::validate(LaTeXFeatures & features) const
+{
+       if (!isASCII(char_))
+               BufferEncodings::validate(char_, features, true);
+}
+
+
 void InsetMathChar::normalize(NormalStream & os) const
 {
        os << "[char ";
@@ -149,20 +187,101 @@ void InsetMathChar::octave(OctaveStream & os) const
 }
 
 
+// We have a bit of a problem here. MathML wants to know whether the
+// character represents an "identifier" or an "operator", and we have
+// no general way of telling. So we shall guess: If it's alpha or 
+// mathalpha, then we'll treat it as an identifier, otherwise as an 
+// operator.
+// Worst case: We get bad spacing, or bad italics.
 void InsetMathChar::mathmlize(MathStream & ms) const
 {
+       std::string entity;
+       switch (char_) {
+               case '<': entity = "&lt;"; break;
+               case '>': entity = "&gt;"; break;
+               case '&': entity = "&amp;"; break;
+               case ' ': {
+                       ms << from_ascii("&nbsp;");
+                       return;
+               }
+               default: break;
+       }
+       
+       if (ms.inText()) {
+               if (entity.empty())
+                       ms.os().put(char_);
+               else 
+                       ms << from_ascii(entity);
+               return;
+       }
+
+       if (!entity.empty()) {
+               ms << "<mo>" << from_ascii(entity) << "</mo>";
+               return;
+       }               
+
+       char const * type = 
+               (isAlphaASCII(char_) || Encodings::isMathAlpha(char_))
+                       ? "mi" : "mo";
+       // we don't use MTag and ETag because we do not want the spacing
+       ms << "<" << type << ">" << char_type(char_) << "</" << type << ">";    
+}
+
+
+void InsetMathChar::htmlize(HtmlStream & ms) const
+{
+       std::string entity;
+       // Not taking subst_ into account here because the MathML output of
+       // <>=+-* looks correct as it is. FIXME: ' is not output as ^\prime
        switch (char_) {
-               case '<': ms << "&lt;"; break;
-               case '>': ms << "&gt;"; break;
-               case '&': ms << "&amp;"; break;
-               default: ms.os().put(char_); break;
+               case '<': entity = "&lt;"; break;
+               case '>': entity = "&gt;"; break;
+               case '&': entity = "&amp;"; break;
+               case ' ': entity = "&nbsp;"; break;
+               default: break;
+       }
+       
+       bool have_entity = !entity.empty();
+       
+       if (ms.inText()) {
+               if (have_entity)
+                       ms << from_ascii(entity);
+               else
+                       ms.os().put(char_);
+               return;
        }
+       
+       if (have_entity) {
+               // an operator, so give some space
+               ms << ' ' << from_ascii(entity) << ' ';
+               return;
+       }               
+
+       if (isAlphaASCII(char_) || Encodings::isMathAlpha(char_))
+               // we don't use MTag and ETag because we do not want the spacing
+               ms << MTag("i") << char_type(char_) << ETag("i");
+       else
+               // an operator, so give some space
+               ms << " " << char_type(char_) << " ";
+}
+
+
+bool InsetMathChar::isMathBin() const
+{
+       return subst_ && subst_->extra == "mathbin";
+}
+
+
+bool InsetMathChar::isMathRel() const
+{
+       return subst_ && subst_->extra == "mathrel";
 }
 
 
-bool InsetMathChar::isRelOp() const
+bool InsetMathChar::isMathPunct() const
 {
-       return char_ == '=' || char_ == '<' || char_ == '>';
+       return support::contains(",;", static_cast<char>(char_))
+               || (subst_ && subst_->extra == "mathpunct");
 }