src/mathed/InsetMathDelim.cpp

   1 /**
   2  * \file InsetMathDelim.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 "InsetMathDelim.h"
  15
  16 #include "MathData.h"
  17 #include "MathFactory.h"
  18 #include "MathStream.h"
  19 #include "MathSupport.h"
  20 #include "MetricsInfo.h"
  21
  22 #include "LaTeXFeatures.h"
  23
  24 #include "support/docstring.h"
  25
  26 #include "frontends/FontMetrics.h"
  27
  28 #include <algorithm>
  29
  30 using namespace std;
  31
  32 namespace lyx {
  33
  34 static docstring convertDelimToLatexName(docstring const & name)
  35 {
  36         if (name.size() == 1) {
  37                 char_type const c = name[0];
  38                 if (c == '<' || c == '(' || c == '[' || c == '.'
  39                     || c == '>' || c == ')' || c == ']' || c == '/' || c == '|')
  40                         return name;
  41         }
  42         return '\\' + name + ' ';
  43 }
  44
  45
  46 InsetMathDelim::InsetMathDelim(Buffer * buf, docstring const & l,
  47                 docstring const & r)
  48         : InsetMathNest(buf, 1), left_(l), right_(r), dw_(0)
  49 {}
  50
  51
  52 InsetMathDelim::InsetMathDelim(Buffer * buf, docstring const & l, docstring const & r,
  53         MathData const & ar)
  54         : InsetMathNest(buf, 1), left_(l), right_(r), dw_(0)
  55 {
  56         cell(0) = ar;
  57 }
  58
  59
  60 Inset * InsetMathDelim::clone() const
  61 {
  62         return new InsetMathDelim(*this);
  63 }
  64
  65
  66 void InsetMathDelim::validate(LaTeXFeatures & features) const
  67 {
  68         InsetMathNest::validate(features);
  69         // The delimiters may be used without \left or \right as well.
  70         // Therefore they are listed in lib/symbols, and if they have
  71         // requirements, we need to add them here.
  72         MathWordList const & words = mathedWordList();
  73         MathWordList::const_iterator it = words.find(left_);
  74         if (it != words.end())
  75         {
  76                 string const req = it->second.requires;
  77                 if (!req.empty())
  78                         features.require(req);
  79         }
  80         it = words.find(right_);
  81         if (it != words.end())
  82         {
  83                 string const req = it->second.requires;
  84                 if (!req.empty())
  85                         features.require(req);
  86         }
  87 }
  88
  89
  90 void InsetMathDelim::write(WriteStream & os) const
  91 {
  92         MathEnsurer ensurer(os);
  93         os << "\\left" << convertDelimToLatexName(left_) << cell(0)
  94            << "\\right" << convertDelimToLatexName(right_);
  95 }
  96
  97
  98 void InsetMathDelim::normalize(NormalStream & os) const
  99 {
 100         os << "[delim " << convertDelimToLatexName(left_) << ' '
 101            << convertDelimToLatexName(right_) << ' ' << cell(0) << ']';
 102 }
 103
 104
 105 void InsetMathDelim::metrics(MetricsInfo & mi, Dimension & dim) const
 106 {
 107         Changer dummy = mi.base.changeEnsureMath();
 108         Dimension dim0;
 109         cell(0).metrics(mi, dim0);
 110         Dimension t = theFontMetrics(mi.base.font).dimension('I');
 111         int h0 = (t.asc + t.des) / 2;
 112         int a0 = max(dim0.asc, t.asc)   - h0;
 113         int d0 = max(dim0.des, t.des)  + h0;
 114         dw_ = dim0.height() / 5;
 115         if (dw_ > 8)
 116                 dw_ = 8;
 117         if (dw_ < 4)
 118                 dw_ = 4;
 119         dim.wid = dim0.width() + 2 * dw_;
 120         dim.asc = max(a0, d0) + h0;
 121         dim.des = max(a0, d0) - h0;
 122 }
 123
 124
 125 void InsetMathDelim::draw(PainterInfo & pi, int x, int y) const
 126 {
 127         Changer dummy = pi.base.changeEnsureMath();
 128         Dimension const dim = dimension(*pi.base.bv);
 129         int const b = y - dim.asc;
 130         cell(0).draw(pi, x + dw_, y);
 131         mathed_draw_deco(pi, x, b, dw_, dim.height(), left_);
 132         mathed_draw_deco(pi, x + dim.width() - dw_,
 133                 b, dw_, dim.height(), right_);
 134         setPosCache(pi, x, y);
 135 }
 136
 137
 138 bool InsetMathDelim::isParenthesis() const
 139 {
 140         return left_ == "(" && right_ == ")";
 141 }
 142
 143
 144 bool InsetMathDelim::isBrackets() const
 145 {
 146         return left_ == "[" && right_ == "]";
 147 }
 148
 149
 150 bool InsetMathDelim::isAbs() const
 151 {
 152         return left_ == "|" && right_ == "|";
 153 }
 154
 155
 156 void InsetMathDelim::maple(MapleStream & os) const
 157 {
 158         if (isAbs()) {
 159                 if (cell(0).size() == 1 && cell(0).front()->asMatrixInset())
 160                         os << "linalg[det](" << cell(0) << ')';
 161                 else
 162                         os << "abs(" << cell(0) << ')';
 163         }
 164         else
 165                 os << left_ << cell(0) << right_;
 166 }
 167
 168
 169 void InsetMathDelim::maxima(MaximaStream & os) const
 170 {
 171         if (isAbs()) {
 172                 if (cell(0).size() == 1 && cell(0).front()->asMatrixInset())
 173                         os << "determinant(" << cell(0) << ')';
 174                 else
 175                         os << "abs(" << cell(0) << ')';
 176         }
 177         else
 178                 os << left_ << cell(0) << right_;
 179 }
 180
 181
 182 void InsetMathDelim::mathematica(MathematicaStream & os) const
 183 {
 184         if (isAbs()) {
 185                 if (cell(0).size() == 1 && cell(0).front()->asMatrixInset())
 186                         os << "Det" << cell(0) << ']';
 187                 else
 188                         os << "Abs[" << cell(0) << ']';
 189         }
 190         else
 191                 os << left_ << cell(0) << right_;
 192 }
 193
 194
 195 void InsetMathDelim::mathmlize(MathStream & os) const
 196 {
 197         os << "<mo form='prefix' fence='true' stretchy='true' symmetric='true'>"
 198            << convertDelimToXMLEscape(left_)
 199            << "</mo>\n"
 200            << cell(0)
 201            << "\n<mo form='postfix' fence='true' stretchy='true' symmetric='true'>"
 202            << convertDelimToXMLEscape(right_)
 203            << "</mo>\n";
 204 }
 205
 206
 207 void InsetMathDelim::htmlize(HtmlStream & os) const
 208 {
 209         os << convertDelimToXMLEscape(left_)
 210            << cell(0)
 211            << convertDelimToXMLEscape(right_);
 212 }
 213
 214
 215 void InsetMathDelim::octave(OctaveStream & os) const
 216 {
 217         if (isAbs())
 218                 os << "det(" << cell(0) << ')';
 219         else
 220                 os << left_ << cell(0) << right_;
 221 }
 222
 223
 224 } // namespace lyx