src/mathed/MathMacroTemplate.C

   1 /**
   2  * \file math_macrotemplate.C
   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 "MathMacroTemplate.h"
  14 #include "MathMLStream.h"
  15 #include "MathParser.h"
  16 #include "MathSupport.h"
  17
  18 #include "cursor.h"
  19 #include "debug.h"
  20 #include "gettext.h"
  21 #include "lyxlex.h"
  22 #include "LColor.h"
  23
  24 #include "frontends/Painter.h"
  25 #include "frontends/font_metrics.h"
  26
  27 #include "support/lstrings.h"
  28
  29 using lyx::docstring;
  30 using lyx::support::bformat;
  31
  32 using std::string;
  33 using std::auto_ptr;
  34 using std::ostream;
  35 using std::endl;
  36
  37
  38 MathMacroTemplate::MathMacroTemplate()
  39         : InsetMathNest(2), numargs_(0), name_(), type_("newcommand")
  40 {
  41         initMath();
  42 }
  43
  44
  45 MathMacroTemplate::MathMacroTemplate(string const & nm, int numargs,
  46                 string const & type, MathArray const & ar1, MathArray const & ar2)
  47         : InsetMathNest(2), numargs_(numargs), name_(nm), type_(type)
  48 {
  49         initMath();
  50
  51         if (numargs_ > 9)
  52                 lyxerr << "MathMacroTemplate::MathMacroTemplate: wrong # of arguments: "
  53                         << numargs_ << std::endl;
  54         cell(0) = ar1;
  55         cell(1) = ar2;
  56 }
  57
  58
  59 MathMacroTemplate::MathMacroTemplate(std::istream & is)
  60         : InsetMathNest(2), numargs_(0), name_()
  61 {
  62         initMath();
  63
  64         MathArray ar;
  65         mathed_parse_cell(ar, is);
  66         if (ar.size() != 1 || !ar[0]->asMacroTemplate()) {
  67                 lyxerr << "cannot read macro from '" << ar << "'" << endl;
  68                 return;
  69         }
  70         operator=( *(ar[0]->asMacroTemplate()) );
  71 }
  72
  73
  74 auto_ptr<InsetBase> MathMacroTemplate::doClone() const
  75 {
  76         return auto_ptr<InsetBase>(new MathMacroTemplate(*this));
  77 }
  78
  79
  80 void MathMacroTemplate::edit(LCursor & cur, bool)
  81 {
  82         lyxerr << "MathMacroTemplate: edit left/right" << endl;
  83         cur.push(*this);
  84 }
  85
  86
  87 int MathMacroTemplate::numargs() const
  88 {
  89         return numargs_;
  90 }
  91
  92
  93 void MathMacroTemplate::numargs(int numargs)
  94 {
  95         numargs_ = numargs;
  96 }
  97
  98
  99 string MathMacroTemplate::name() const
 100 {
 101         return name_;
 102 }
 103
 104
 105 docstring MathMacroTemplate::prefix() const
 106 {
 107         // FIXME UNICODE
 108         // delete the conversion when bformat() will return a docstring.
 109         // delete the conversion when bformat() takes a docstring arg.
 110         return bformat(_(" Macro: %1$s: "), lyx::from_utf8(name_));
 111 }
 112
 113
 114 void MathMacroTemplate::metrics(MetricsInfo & mi, Dimension & dim) const
 115 {
 116         cell(0).metrics(mi);
 117         cell(1).metrics(mi);
 118         docstring dp = prefix();
 119         dim.wid = cell(0).width() + cell(1).width() + 20
 120                 + font_metrics::width(dp, mi.base.font);
 121         dim.asc = std::max(cell(0).ascent(),  cell(1).ascent())  + 7;
 122         dim.des = std::max(cell(0).descent(), cell(1).descent()) + 7;
 123         dim_ = dim;
 124 }
 125
 126
 127 void MathMacroTemplate::draw(PainterInfo & p, int x, int y) const
 128 {
 129         setPosCache(p, x, y);
 130
 131         // label
 132         LyXFont font = p.base.font;
 133         font.setColor(LColor::math);
 134
 135         PainterInfo pi(p.base.bv, p.pain);
 136         pi.base.style = LM_ST_TEXT;
 137         pi.base.font  = font;
 138
 139         int const a = y - dim_.asc + 1;
 140         int const w = dim_.wid - 2;
 141         int const h = dim_.height() - 2;
 142
 143         // LColor::mathbg used to be "AntiqueWhite" but is "linen" now, too
 144         // the next line would overwrite the selection!
 145         //pi.pain.fillRectangle(x, a, w, h, LColor::mathmacrobg);
 146         pi.pain.rectangle(x, a, w, h, LColor::mathframe);
 147
 148 #ifdef WITH_WARNINGS
 149 #warning FIXME
 150 #endif
 151 #if 0
 152         LCursor & cur = p.base.bv->cursor();
 153         if (cur.isInside(this))
 154                 cur.drawSelection(pi);
 155 #endif
 156         docstring dp = prefix();
 157         pi.pain.text(x + 2, y, dp, font);
 158         x += font_metrics::width(dp, pi.base.font) + 6;
 159
 160         int const w0 = cell(0).width();
 161         int const w1 = cell(1).width();
 162         cell(0).draw(pi, x + 2, y + 1);
 163         pi.pain.rectangle(x, y - dim_.ascent() + 3,
 164                 w0 + 4, dim_.height() - 6, LColor::mathline);
 165         cell(1).draw(pi, x + 8 + w0, y + 1);
 166         pi.pain.rectangle(x + w0 + 6, y - dim_.ascent() + 3,
 167                 w1 + 4, dim_.height() - 6, LColor::mathline);
 168 }
 169
 170
 171 void MathMacroTemplate::read(Buffer const &, LyXLex & lex)
 172 {
 173         MathArray ar;
 174         mathed_parse_cell(ar, lex.getStream());
 175         if (ar.size() != 1 || !ar[0]->asMacroTemplate()) {
 176                 lyxerr << "cannot read macro from '" << ar << "'" << endl;
 177                 return;
 178         }
 179         operator=( *(ar[0]->asMacroTemplate()) );
 180 }
 181
 182
 183 void MathMacroTemplate::write(Buffer const &, std::ostream & os) const
 184 {
 185         WriteStream wi(os, false, false);
 186         os << "FormulaMacro\n";
 187         write(wi);
 188 }
 189
 190
 191 void MathMacroTemplate::write(WriteStream & os) const
 192 {
 193         if (type_ == "def") {
 194                 os << "\\def\\" << name_.c_str();
 195                 for (int i = 1; i <= numargs_; ++i)
 196                         os << '#' << i;
 197         } else {
 198                 // newcommand or renewcommand
 199                 os << "\\" << type_.c_str() << "{\\" << name_.c_str() << '}';
 200                 if (numargs_ > 0)
 201                         os << '[' << numargs_ << ']';
 202         }
 203
 204         os << '{' << cell(0) << "}";
 205
 206         if (os.latex()) {
 207                 // writing .tex. done.
 208                 os << "\n";
 209         } else {
 210                 // writing .lyx, write special .tex export only if necessary
 211                 if (!cell(1).empty())
 212                         os << "\n{" << cell(1) << '}';
 213         }
 214 }
 215
 216
 217 MacroData MathMacroTemplate::asMacroData() const
 218 {
 219         return MacroData(asString(cell(0)), numargs(), asString(cell(1)));
 220 }