src/mathed/InsetMathDecoration.cpp

   1 /**
   2  * \file InsetMathDecoration.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Alejandro Aguilar Sierra
   7  * \author André Pönitz
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "InsetMathDecoration.h"
  15
  16 #include "MathData.h"
  17 #include "MathParser.h"
  18 #include "MathSupport.h"
  19 #include "MathStream.h"
  20 #include "MetricsInfo.h"
  21
  22 #include "LaTeXFeatures.h"
  23
  24 #include "support/debug.h"
  25 #include "support/docstring.h"
  26 #include "support/lassert.h"
  27
  28 #include <ostream>
  29
  30 using namespace std;
  31
  32 namespace lyx {
  33
  34
  35 InsetMathDecoration::InsetMathDecoration(Buffer * buf, latexkeys const * key)
  36         : InsetMathNest(buf, 1), key_(key)
  37 {
  38 //      lyxerr << " creating deco " << key->name << endl;
  39 }
  40
  41
  42 Inset * InsetMathDecoration::clone() const
  43 {
  44         return new InsetMathDecoration(*this);
  45 }
  46
  47
  48 bool InsetMathDecoration::upper() const
  49 {
  50         return key_->name.substr(0, 5) != "under";
  51 }
  52
  53
  54 bool InsetMathDecoration::isScriptable() const
  55 {
  56         return
  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";
  65 }
  66
  67
  68 bool InsetMathDecoration::protect() const
  69 {
  70         return
  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";
  79 }
  80
  81
  82 bool InsetMathDecoration::wide() const
  83 {
  84         return
  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 }
  98
  99
 100 InsetMath::mode_type InsetMathDecoration::currentMode() const
 101 {
 102         return key_->name == "underbar" ? TEXT_MODE : MATH_MODE;
 103 }
 104
 105
 106 void InsetMathDecoration::metrics(MetricsInfo & mi, Dimension & dim) const
 107 {
 108         bool const upshape = currentMode() == TEXT_MODE
 109                                 && isMathFont(from_ascii(mi.base.fontname));
 110         ShapeChanger dummy(mi.base.font, upshape ?
 111                                 UP_SHAPE : mi.base.font.shape());
 112
 113         cell(0).metrics(mi, dim);
 114
 115         dh_  = 6; //mathed_char_height(LM_TC_VAR, mi, 'I', ascent_, descent_);
 116         dw_  = 6; //mathed_char_width(LM_TC_VAR, mi, 'x');
 117
 118         if (upper()) {
 119                 dy_ = -dim.asc - dh_;
 120                 dim.asc += dh_ + 1;
 121         } else {
 122                 dy_ = dim.des + 1;
 123                 dim.des += dh_ + 2;
 124         }
 125
 126         metricsMarkers(dim);
 127 }
 128
 129
 130 void InsetMathDecoration::draw(PainterInfo & pi, int x, int y) const
 131 {
 132         bool const upshape = currentMode() == TEXT_MODE
 133                                 && isMathFont(from_ascii(pi.base.fontname));
 134         ShapeChanger dummy(pi.base.font, upshape ?
 135                                 UP_SHAPE : pi.base.font.shape());
 136
 137         cell(0).draw(pi, x + 1, y);
 138         Dimension const & dim0 = cell(0).dimension(*pi.base.bv);
 139         if (wide())
 140                 mathed_draw_deco(pi, x + 1, y + dy_, dim0.wid, dh_, key_->name);
 141         else
 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);
 146 }
 147
 148
 149 void InsetMathDecoration::write(WriteStream & os) const
 150 {
 151         MathEnsurer ensurer(os);
 152         if (os.fragile() && protect())
 153                 os << "\\protect";
 154         os << '\\' << key_->name << '{';
 155         ModeSpecifier specifier(os, currentMode());
 156         os << cell(0) << '}';
 157 }
 158
 159
 160 void InsetMathDecoration::normalize(NormalStream & os) const
 161 {
 162         os << "[deco " << key_->name << ' ' <<  cell(0) << ']';
 163 }
 164
 165
 166 void InsetMathDecoration::infoize(odocstream & os) const
 167 {
 168         os << "Deco: " << key_->name;
 169 }
 170
 171
 172 namespace {
 173         struct Attributes {
 174                 Attributes() {}
 175                 Attributes(bool o, string t)
 176                         : over(o), tag(t) {}
 177                 bool over;
 178                 string tag;
 179         };
 180
 181         typedef map<string, Attributes> TranslationMap;
 182
 183         void buildTranslationMap(TranslationMap & t) {
 184                 // the decorations we need to support are listed in lib/symbols
 185                 t["acute"] = Attributes(true, "&acute;");
 186                 t["bar"]   = Attributes(true, "&OverBar;");
 187                 t["breve"] = Attributes(true, "&breve;");
 188                 t["check"] = Attributes(true, "&caron;");
 189                 t["ddddot"] = Attributes(true, "&DotDot;");
 190                 t["dddot"] = Attributes(true, "&TripleDot;");
 191                 t["ddot"] = Attributes(true, "&Dot;");
 192                 t["dot"] = Attributes(true, "&dot;");
 193                 t["grave"] = Attributes(true, "&grave;");
 194                 t["hat"] = Attributes(true, "&circ;");
 195                 t["mathring"] = Attributes(true, "&ring;");
 196                 t["overbrace"] = Attributes(true, "&OverBrace;");
 197                 t["overleftarrow"] = Attributes(true, "&xlarr;");
 198                 t["overleftrightarrow"] = Attributes(true, "&xharr;");
 199                 t["overline"] = Attributes(true, "&macr;");
 200                 t["overrightarrow"] = Attributes(true, "&xrarr;");
 201                 t["tilde"] = Attributes(true, "&tilde;");
 202                 t["underbar"] = Attributes(false, "&UnderBar;");
 203                 t["underbrace"] = Attributes(false, "&UnderBrace;");
 204                 t["underleftarrow"] = Attributes(false, "&xlarr;");
 205                 t["underleftrightarrow"] = Attributes(false, "&xharr;");
 206                 // this is the macron, again, but it works
 207                 t["underline"] = Attributes(false, "&macr;");
 208                 t["underrightarrow"] = Attributes(false, "&xrarr;");
 209                 t["vec"] = Attributes(true, "&rarr;");
 210                 t["widehat"] = Attributes(true, "&Hat;");
 211                 t["widetilde"] = Attributes(true, "&Tilde;");
 212         }
 213
 214         TranslationMap const & translationMap() {
 215                 static TranslationMap t;
 216                 if (t.empty())
 217                         buildTranslationMap(t);
 218                 return t;
 219         }
 220 }
 221
 222 void InsetMathDecoration::mathmlize(MathStream & os) const
 223 {
 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";
 228         os << MTag(outag)
 229                  << MTag("mrow") << cell(0) << ETag("mrow")
 230                  << from_ascii("<mo stretchy=\"true\">" + cur->second.tag + "</mo>")
 231                  << ETag(outag);
 232 }
 233
 234
 235 void InsetMathDecoration::htmlize(HtmlStream & os) const
 236 {
 237         string const name = to_utf8(key_->name);
 238         if (name == "bar") {
 239                 os << MTag("span", "class='overbar'") << cell(0) << ETag("span");
 240                 return;
 241         }
 242
 243         if (name == "underbar" || name == "underline") {
 244                 os << MTag("span", "class='underbar'") << cell(0) << ETag("span");
 245                 return;
 246         }
 247
 248         TranslationMap const & t = translationMap();
 249         TranslationMap::const_iterator cur = t.find(name);
 250         LASSERT(cur != t.end(), return);
 251
 252         bool symontop = cur->second.over;
 253         string const symclass = symontop ? "symontop" : "symonbot";
 254         os << MTag("span", "class='symbolpair " + symclass + "'")
 255            << '\n';
 256
 257         if (symontop)
 258                 os << MTag("span", "class='symbol'") << from_ascii(cur->second.tag);
 259         else
 260                 os << MTag("span", "class='base'") << cell(0);
 261         os << ETag("span") << '\n';
 262         if (symontop)
 263                 os << MTag("span", "class='base'") << cell(0);
 264         else
 265                 os << MTag("span", "class='symbol'") << from_ascii(cur->second.tag);
 266         os << ETag("span") << '\n' << ETag("span") << '\n';
 267 }
 268
 269
 270 // ideas borrowed from the eLyXer code
 271 void InsetMathDecoration::validate(LaTeXFeatures & features) const
 272 {
 273         if (features.runparams().math_flavor == OutputParams::MathAsHTML) {
 274                 string const name = to_utf8(key_->name);
 275                 if (name == "bar") {
 276                         features.addPreambleSnippet("<style type=\"text/css\">\n"
 277                                 "span.overbar{border-top: thin black solid;}\n"
 278                                 "</style>");
 279                 } else if (name == "underbar" || name == "underline") {
 280                         features.addPreambleSnippet("<style type=\"text/css\">\n"
 281                                 "span.underbar{border-bottom: thin black solid;}\n"
 282                                 "</style>");
 283                 } else {
 284                         features.addPreambleSnippet("<style type=\"text/css\">\n"
 285                                 "span.symbolpair{display: inline-block; text-align:center;}\n"
 286                                 "span.symontop{vertical-align: top;}\n"
 287                                 "span.symonbot{vertical-align: bottom;}\n"
 288                                 "span.symbolpair span{display: block;}\n"
 289                                 "span.symbol{height: 0.5ex;}\n"
 290                                 "</style>");
 291                 }
 292         } else {
 293                 if (!key_->requires.empty())
 294                         features.require(to_utf8(key_->requires));
 295         }
 296         InsetMathNest::validate(features);
 297 }
 298
 299 } // namespace lyx