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