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/gettext.h"
  27 #include "support/lassert.h"
  28 #include "support/lstrings.h"
  29
  30 #include <ostream>
  31
  32 using namespace lyx::support;
  33
  34 using namespace std;
  35
  36 namespace lyx {
  37
  38
  39 InsetMathDecoration::InsetMathDecoration(Buffer * buf, latexkeys const * key)
  40         : InsetMathNest(buf, 1), key_(key), dh_(0), dy_(0), dw_(0)
  41 {
  42 //      lyxerr << " creating deco " << key->name << endl;
  43 }
  44
  45
  46 Inset * InsetMathDecoration::clone() const
  47 {
  48         return new InsetMathDecoration(*this);
  49 }
  50
  51
  52 bool InsetMathDecoration::upper() const
  53 {
  54         return key_->name.substr(0, 5) != "under" && key_->name != "utilde";
  55 }
  56
  57
  58 bool InsetMathDecoration::isScriptable() const
  59 {
  60         return
  61                         key_->name == "overbrace" ||
  62                         key_->name == "underbrace";
  63 }
  64
  65
  66 bool InsetMathDecoration::protect() const
  67 {
  68         return
  69                         key_->name == "overbrace" ||
  70                         key_->name == "underbrace" ||
  71                         key_->name == "overleftarrow" ||
  72                         key_->name == "overrightarrow" ||
  73                         key_->name == "overleftrightarrow" ||
  74                         key_->name == "underleftarrow" ||
  75                         key_->name == "underrightarrow" ||
  76                         key_->name == "underleftrightarrow";
  77 }
  78
  79
  80 bool InsetMathDecoration::wide() const
  81 {
  82         return
  83                         key_->name == "overline" ||
  84                         key_->name == "underline" ||
  85                         key_->name == "overbrace" ||
  86                         key_->name == "underbrace" ||
  87                         key_->name == "overleftarrow" ||
  88                         key_->name == "overrightarrow" ||
  89                         key_->name == "overleftrightarrow" ||
  90                         key_->name == "widehat" ||
  91                         key_->name == "widetilde" ||
  92                         key_->name == "underleftarrow" ||
  93                         key_->name == "underrightarrow" ||
  94                         key_->name == "underleftrightarrow" ||
  95                         key_->name == "undertilde" ||
  96                         key_->name == "utilde";
  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         Changer dummy = mi.base.changeEnsureMath(currentMode());
 109
 110         cell(0).metrics(mi, dim);
 111
 112         dh_  = 6; //mathed_char_height(LM_TC_VAR, mi, 'I', ascent_, descent_);
 113         dw_  = 6; //mathed_char_width(LM_TC_VAR, mi, 'x');
 114
 115         if (upper()) {
 116                 dy_ = -dim.asc - dh_;
 117                 dim.asc += dh_ + 1;
 118         } else {
 119                 dy_ = dim.des + 1;
 120                 dim.des += dh_ + 2;
 121         }
 122
 123         metricsMarkers(mi, dim);
 124 }
 125
 126
 127 void InsetMathDecoration::draw(PainterInfo & pi, int x, int y) const
 128 {
 129         Changer dummy = pi.base.changeEnsureMath(currentMode());
 130
 131         cell(0).draw(pi, x + 1, y);
 132         Dimension const & dim0 = cell(0).dimension(*pi.base.bv);
 133         if (wide())
 134                 mathed_draw_deco(pi, x + 1, y + dy_, dim0.wid, dh_, key_->name);
 135         else
 136                 mathed_draw_deco(pi, x + 1 + (dim0.wid - dw_) / 2,
 137                         y + dy_, dw_, dh_, key_->name);
 138         drawMarkers(pi, x, y);
 139 }
 140
 141
 142 void InsetMathDecoration::write(WriteStream & os) const
 143 {
 144         MathEnsurer ensurer(os);
 145         if (os.fragile() && protect())
 146                 os << "\\protect";
 147         os << '\\' << key_->name << '{';
 148         ModeSpecifier specifier(os, currentMode());
 149         os << cell(0) << '}';
 150 }
 151
 152
 153 void InsetMathDecoration::normalize(NormalStream & os) const
 154 {
 155         os << "[deco " << key_->name << ' ' <<  cell(0) << ']';
 156 }
 157
 158
 159 void InsetMathDecoration::infoize(odocstream & os) const
 160 {
 161         os << bformat(_("Decoration: %1$s"), key_->name);
 162 }
 163
 164
 165 namespace {
 166         struct Attributes {
 167                 Attributes() : over(false) {}
 168                 Attributes(bool o, string t)
 169                         : over(o), tag(t) {}
 170                 bool over;
 171                 string tag;
 172         };
 173
 174         typedef map<string, Attributes> TranslationMap;
 175
 176         void buildTranslationMap(TranslationMap & t) {
 177                 // the decorations we need to support are listed in lib/symbols
 178                 t["acute"] = Attributes(true, "&acute;");
 179                 t["bar"]   = Attributes(true, "&OverBar;");
 180                 t["breve"] = Attributes(true, "&breve;");
 181                 t["check"] = Attributes(true, "&caron;");
 182                 t["ddddot"] = Attributes(true, "&DotDot;");
 183                 t["dddot"] = Attributes(true, "&TripleDot;");
 184                 t["ddot"] = Attributes(true, "&Dot;");
 185                 t["dot"] = Attributes(true, "&dot;");
 186                 t["grave"] = Attributes(true, "&grave;");
 187                 t["hat"] = Attributes(true, "&circ;");
 188                 t["mathring"] = Attributes(true, "&ring;");
 189                 t["overbrace"] = Attributes(true, "&OverBrace;");
 190                 t["overleftarrow"] = Attributes(true, "&xlarr;");
 191                 t["overleftrightarrow"] = Attributes(true, "&xharr;");
 192                 t["overline"] = Attributes(true, "&macr;");
 193                 t["overrightarrow"] = Attributes(true, "&xrarr;");
 194                 t["tilde"] = Attributes(true, "&tilde;");
 195                 t["underbar"] = Attributes(false, "&UnderBar;");
 196                 t["underbrace"] = Attributes(false, "&UnderBrace;");
 197                 t["underleftarrow"] = Attributes(false, "&xlarr;");
 198                 t["underleftrightarrow"] = Attributes(false, "&xharr;");
 199                 // this is the macron, again, but it works
 200                 t["underline"] = Attributes(false, "&macr;");
 201                 t["underrightarrow"] = Attributes(false, "&xrarr;");
 202                 t["undertilde"] = Attributes(false, "&Tilde;");
 203                 t["utilde"] = Attributes(false, "&Tilde;");
 204                 t["vec"] = Attributes(true, "&rarr;");
 205                 t["widehat"] = Attributes(true, "&Hat;");
 206                 t["widetilde"] = Attributes(true, "&Tilde;");
 207         }
 208
 209         TranslationMap const & translationMap() {
 210                 static TranslationMap t;
 211                 if (t.empty())
 212                         buildTranslationMap(t);
 213                 return t;
 214         }
 215 }
 216
 217 void InsetMathDecoration::mathmlize(MathStream & os) const
 218 {
 219         TranslationMap const & t = translationMap();
 220         TranslationMap::const_iterator cur = t.find(to_utf8(key_->name));
 221         LASSERT(cur != t.end(), return);
 222         char const * const outag = cur->second.over ? "mover" : "munder";
 223         os << MTag(outag)
 224                  << MTag("mrow") << cell(0) << ETag("mrow")
 225                  << from_ascii("<mo stretchy=\"true\">" + cur->second.tag + "</mo>")
 226                  << ETag(outag);
 227 }
 228
 229
 230 void InsetMathDecoration::htmlize(HtmlStream & os) const
 231 {
 232         string const name = to_utf8(key_->name);
 233         if (name == "bar") {
 234                 os << MTag("span", "class='overbar'") << cell(0) << ETag("span");
 235                 return;
 236         }
 237
 238         if (name == "underbar" || name == "underline") {
 239                 os << MTag("span", "class='underbar'") << cell(0) << ETag("span");
 240                 return;
 241         }
 242
 243         TranslationMap const & t = translationMap();
 244         TranslationMap::const_iterator cur = t.find(name);
 245         LASSERT(cur != t.end(), return);
 246
 247         bool symontop = cur->second.over;
 248         string const symclass = symontop ? "symontop" : "symonbot";
 249         os << MTag("span", "class='symbolpair " + symclass + "'")
 250            << '\n';
 251
 252         if (symontop)
 253                 os << MTag("span", "class='symbol'") << from_ascii(cur->second.tag);
 254         else
 255                 os << MTag("span", "class='base'") << cell(0);
 256         os << ETag("span") << '\n';
 257         if (symontop)
 258                 os << MTag("span", "class='base'") << cell(0);
 259         else
 260                 os << MTag("span", "class='symbol'") << from_ascii(cur->second.tag);
 261         os << ETag("span") << '\n' << ETag("span") << '\n';
 262 }
 263
 264
 265 // ideas borrowed from the eLyXer code
 266 void InsetMathDecoration::validate(LaTeXFeatures & features) const
 267 {
 268         if (features.runparams().math_flavor == OutputParams::MathAsHTML) {
 269                 string const name = to_utf8(key_->name);
 270                 if (name == "bar") {
 271                         features.addCSSSnippet("span.overbar{border-top: thin black solid;}");
 272                 } else if (name == "underbar" || name == "underline") {
 273                         features.addCSSSnippet("span.underbar{border-bottom: thin black solid;}");
 274                 } else {
 275                         features.addCSSSnippet(
 276                                 "span.symbolpair{display: inline-block; text-align:center;}\n"
 277                                 "span.symontop{vertical-align: top;}\n"
 278                                 "span.symonbot{vertical-align: bottom;}\n"
 279                                 "span.symbolpair span{display: block;}\n"
 280                                 "span.symbol{height: 0.5ex;}");
 281                 }
 282         } else {
 283                 if (!key_->requires.empty())
 284                         features.require(key_->requires);
 285         }
 286         InsetMathNest::validate(features);
 287 }
 288
 289 } // namespace lyx