src/mathed/InsetMathSymbol.cpp

   1 /**
   2  * \file InsetMathSymbol.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author André Pönitz
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "InsetMathSymbol.h"
  14 #include "Dimension.h"
  15 #include "MathStream.h"
  16 #include "MathStream.h"
  17 #include "MathSupport.h"
  18 #include "MathParser.h"
  19 #include "MathAtom.h"
  20 #include "LaTeXFeatures.h"
  21
  22 #include "debug.h"
  23
  24 #include "support/textutils.h"
  25
  26
  27 namespace lyx {
  28
  29 InsetMathSymbol::InsetMathSymbol(latexkeys const * l)
  30         : sym_(l), h_(0), scriptable_(false)
  31 {}
  32
  33
  34 InsetMathSymbol::InsetMathSymbol(char const * name)
  35         : sym_(in_word_set(from_ascii(name))), h_(0), scriptable_(false)
  36 {}
  37
  38
  39 InsetMathSymbol::InsetMathSymbol(docstring const & name)
  40         : sym_(in_word_set(name)), h_(0), scriptable_(false)
  41 {}
  42
  43
  44 Inset * InsetMathSymbol::clone() const
  45 {
  46         return new InsetMathSymbol(*this);
  47 }
  48
  49
  50 docstring InsetMathSymbol::name() const
  51 {
  52         return sym_->name;
  53 }
  54
  55
  56 void InsetMathSymbol::metrics(MetricsInfo & mi, Dimension & dim) const
  57 {
  58         //lyxerr << "metrics: symbol: '" << sym_->name
  59         //      << "' in font: '" << sym_->inset
  60         //      << "' drawn as: '" << sym_->draw
  61         //      << "'" << std::endl;
  62
  63         int const em = mathed_char_width(mi.base.font, 'M');
  64         FontSetChanger dummy(mi.base, sym_->inset);
  65         mathed_string_dim(mi.base.font, sym_->draw, dim);
  66         docstring::const_reverse_iterator rit = sym_->draw.rbegin();
  67         kerning_ = mathed_char_kerning(mi.base.font, *rit);
  68         // correct height for broken cmex and wasy font
  69         if (sym_->inset == "cmex" || sym_->inset == "wasy") {
  70                 h_ = 4 * dim.des / 5;
  71                 dim.asc += h_;
  72                 dim.des -= h_;
  73         }
  74         // seperate things a bit
  75         if (isRelOp())
  76                 dim.wid += static_cast<int>(0.5 * em + 0.5);
  77         else
  78                 dim.wid += static_cast<int>(0.1667 * em + 0.5);
  79
  80         scriptable_ = false;
  81         if (mi.base.style == LM_ST_DISPLAY)
  82                 if (sym_->inset == "cmex" || sym_->inset == "esint" ||
  83                     sym_->extra == "funclim")
  84                         scriptable_ = true;
  85
  86         // Cache the inset dimension.
  87         setDimCache(mi, dim);
  88 }
  89
  90
  91 void InsetMathSymbol::draw(PainterInfo & pi, int x, int y) const
  92 {
  93         //lyxerr << "metrics: symbol: '" << sym_->name
  94         //      << "' in font: '" << sym_->inset
  95         //      << "' drawn as: '" << sym_->draw
  96         //      << "'" << std::endl;
  97         int const em = mathed_char_width(pi.base.font, 'M');
  98         if (isRelOp())
  99                 x += static_cast<int>(0.25*em+0.5);
 100         else
 101                 x += static_cast<int>(0.0833*em+0.5);
 102
 103         FontSetChanger dummy(pi.base, sym_->inset.c_str());
 104         pi.draw(x, y - h_, sym_->draw);
 105 }
 106
 107
 108 bool InsetMathSymbol::isRelOp() const
 109 {
 110         return sym_->extra == "mathrel";
 111 }
 112
 113
 114 bool InsetMathSymbol::isOrdAlpha() const
 115 {
 116         return sym_->extra == "mathord" || sym_->extra == "mathalpha";
 117 }
 118
 119
 120 bool InsetMathSymbol::isScriptable() const
 121 {
 122         return scriptable_;
 123 }
 124
 125
 126 bool InsetMathSymbol::takesLimits() const
 127 {
 128         return
 129                 sym_->inset == "cmex" ||
 130                 sym_->inset == "lyxboldsymb" ||
 131                 sym_->inset == "esint" ||
 132                 sym_->extra == "funclim";
 133 }
 134
 135
 136 void InsetMathSymbol::validate(LaTeXFeatures & features) const
 137 {
 138         if (!sym_->requires.empty())
 139                 features.require(to_utf8(sym_->requires));
 140 }
 141
 142
 143 void InsetMathSymbol::normalize(NormalStream & os) const
 144 {
 145         os << "[symbol " << name() << ']';
 146 }
 147
 148
 149 void InsetMathSymbol::maple(MapleStream & os) const
 150 {
 151         if (name() == "cdot")
 152                 os << '*';
 153         else if (name() == "infty")
 154                 os << "infinity";
 155         else
 156                 os << name();
 157 }
 158
 159 void InsetMathSymbol::maxima(MaximaStream & os) const
 160 {
 161         if (name() == "cdot")
 162                 os << '*';
 163         else if (name() == "infty")
 164                 os << "inf";
 165         else if (name() == "pi")
 166                 os << "%pi";
 167         else
 168                 os << name();
 169 }
 170
 171
 172 void InsetMathSymbol::mathematica(MathematicaStream & os) const
 173 {
 174         if ( name() == "pi")    { os << "Pi"; return;}
 175         if ( name() == "infty") { os << "Infinity"; return;}
 176         if ( name() == "cdot")  { os << '*'; return;}
 177         os << name();
 178 }
 179
 180
 181 char const * MathMLtype(docstring const & s)
 182 {
 183         if (s == "mathop")
 184                 return "mo";
 185         return "mi";
 186 }
 187
 188
 189 void InsetMathSymbol::mathmlize(MathStream & os) const
 190 {
 191         char const * type = MathMLtype(sym_->extra);
 192         os << '<' << type << "> ";
 193         if (sym_->xmlname == "x") // unknown so far
 194                 os << name();
 195         else
 196                 os << sym_->xmlname;
 197         os << " </" << type << '>';
 198 }
 199
 200
 201 void InsetMathSymbol::octave(OctaveStream & os) const
 202 {
 203         if (name() == "cdot")
 204                 os << '*';
 205         else
 206                 os << name();
 207 }
 208
 209
 210 void InsetMathSymbol::write(WriteStream & os) const
 211 {
 212         os << '\\' << name();
 213
 214         // $,#, etc. In theory the restriction based on catcodes, but then
 215         // we do not handle catcodes very well, let alone cat code changes,
 216         // so being outside the alpha range is good enough.
 217         if (name().size() == 1 && !isAlphaASCII(name()[0]))
 218                 return;
 219
 220         os.pendingSpace(true);
 221 }
 222
 223
 224 void InsetMathSymbol::infoize2(odocstream & os) const
 225 {
 226         os << from_ascii("Symbol: ") << name();
 227 }
 228
 229
 230 } // namespace lyx